koohishihara / split.js

Lightweight, unopinionated utility for adjustable split views

Split.js

Split.js is a lightweight, unopinionated utility for creating adjustable split views or panes. Demo.

No dependencies or markup required, just two or more elements with a common parent. Views can be split horizontally or vertically, with draggable gutters inserted between every two elements.

Installation

Include the minified build from CDNJS:

<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/split.js/1.2.0/split.min.js"></script>

Install with NPM:

npm install split.js

Bower:

bower install Split.js

Or clone from Github:

git clone https://github.com/nathancahill/Split.js.git

Documentation

Split(<HTMLElement|selector[]> elements, <options> options?)

Options	Type	Default	Description
sizes	Array		Initial sizes of each element in percents or CSS values.
minSize	Number or Array	100	Minimum size of each element.
gutterSize	Number	10	Gutter size in pixels.
snapOffset	Number	30	Snap to minimum size offset in pixels.
direction	String	'horizontal'	Direction to split: horizontal or vertical.
cursor	String	'col-resize'	Cursor to display while dragging.
elementStyle	Function		Called to set the style of each element.
gutterStyle	Function		Called to set the style of the gutter.
onDrag	Function		Callback on drag.
onDragStart	Function		Callback on drag start.
onDragEnd	Function		Callback on drag end.

Important Note: Split.js does not set CSS beyond the minimum needed to manage the width and height of the elements. This is by design. It makes Split.js flexible and useful in many different situations. If you create a horizontal split, you are responsible for (likely) floating the elements and the gutter, and setting their heights. See the CSS section below.

Options

sizes

An array of initial sizes of the elements, specified as percentage values. Example: Setting the initial sizes to 25% and 75%.

Split(['#one', '#two'], {
    sizes: [25, 75]
})

minSize. Default: 100

An array of minimum sizes of the elements, specified as pixel values. Example: Setting the minimum sizes to 100px and 300px, respectively.

Split(['#one', '#two'], {
    sizes: [100, 300]
})

If a number is passed instead of an array, all elements are set to the same minimum size:

Split(['#one', '#two'], {
    sizes: 100
})

gutterSize. Default: 10

Gutter size in pixels. Example: Setting the gutter size to 20px.

Split(['#one', '#two'], {
    gutterSize: 20
})

snapOffset. Default: 30

Snap to minimum size at this offset in pixels. Example: Set to 0 to disable to snap effect.

Split(['#one', '#two'], {
    snapOffset: 0
})

direction. Default: 'horizontal'

Direction to split in. Can be 'vertical' or 'horizontal'. Determines which CSS properties are applied (ie. width/height) to each element and gutter. Example: split vertically:

Split(['#one', '#two'], {
    direction: 'vertical'
})

cursor. Default: 'col-resize'

Cursor to show on the gutter (also applied to the two adjacent elements when dragging to prevent flickering). Defaults to 'col-resize', so should be switched to 'row-resize' when using direction: 'vertical':

Split(['#one', '#two'], {
    direction: 'vertical',
    cursor: 'row-resize'
})

elementStyle

Optional function called setting the CSS style of the elements. The signature looks like this:

function (dimension, elementSize, gutterSize) {}

Dimension will be a string, 'width' or 'height', and can be used in the return style. elementSize is the target percentage value of the element, and gutterSize is the target pixel value of the gutter.

It should return an object with CSS properties to apply to the element. For horizontal splits, the return object looks like this:

{
    'width': 'calc(50% - 5px)'
}

A vertical split style would look like this:

{
    'height': 'calc(50% - 5px)'
}

Use this function if you're using a different layout like flexbox or grid (see Flexbox). A flexbox style for a horizontal split would look like this:

{
    'flex-basis': 'calc(50% - 5px)'
}

gutterStyle

Optional function called when setting the CSS style of the gutters. The signature looks like this:

function (dimension, gutterSize) {}

Dimension is a string, either 'width' or 'height', and gutterSize is a pixel value representing the width of the gutter.

It should return a similar object as elementStyle, an object with CSS properties to apply to the gutter. Since gutters have fixed widths, it will generally look like this:

{
    'width': '10px'
}

Both elementStyle and gutterStyle are called continously while dragging, so don't do anything besides return the style object in these functions.

onDrag, onDragStart, onDragEnd

Callbacks that can be added on drag (fired continously), drag start and drag end. If doing more than basic operations in onDrag, add a debounce function to rate limit the callback.

Usage Examples

Reference HTML for examples. Gutters are inserted automatically:

<div>
    <div id="one">content one</div>
    <div id="two">content two</div>
    <div id="three">content three</div>
</div>

A split with two elements, starting at 25% and 75% wide with 200px minimum width.

Split(['#one', '#two'], {
    sizes: [25, 75],
    minSize: 200
});

A split with three elements, starting with even widths with 100px, 100px and 300px minimum widths, respectively.

Split(['#one', '#two', '#three'], {
    minSize: [100, 100, 300]
});

A vertical split with two elements.

Split(['#one', '#two'], {
    direction: 'vertical'
});

Specifying the initial widths with CSS values. Not recommended, the size/gutter calculations would have to be done before hand and won't scale on viewport resize.

Split(['#one', '#two'], {
	sizes: ['200px', '500px']
});

JSFiddle style is also possible: Demo.

Saving State

Use local storage to save the most recent state:

var sizes = localStorage.getItem('split-sizes')

if (sizes) {
    sizes = JSON.parse(sizes)
} else {
    sizes = [50, 50]  // default sizes
}

var split = Split(['#one', '#two'], {
    sizes: sizes,
    onDragEnd: function () {
        localStorage.setItem('split-sizes', JSON.stringify(split.getSizes()));
    }
})

Flexbox

Flexbox layout is supported by customizing the elementStyle and gutterStyle CSS. Given a layout like this:

<div id="flex">
    <div id="flex-1"></div>
    <div id="flex-2"></div>
</div>

And CSS style like this:

#flex {
    display: flex;
    flex-direction: row;
}

Then the elementStyle and gutterStyle can be used to set flex-basis:

Split(['#flex-1', '#flex-2'], {
    elementStyle: function (dimension, size, gutterSize) {
        return {
            'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)'
        }
    },
    gutterStyle: function (dimension, gutterSize) {
        return {
            'flex-basis':  gutterSize + 'px'
        }
    }
})

API

Split.js returns an instance with a couple of functions. The instance is returned on creation:

var instance = Split([], ...)

.setSizes([])

setSizes behaves the same as the sizes configuration option, passing an array of percents or CSS values. It updates the sizes of the elements in the split. Added in v1.1.0:

instance.setSizes([25, 75])

.getSizes()

getSizes returns an array of percents, suitable for using with setSizes or creation. Added in v1.1.2:

instance.getSizes()
> [25, 75]

.collapse(index)

collapse changes the size of element at index to 0. Every element except the last is collapsed towards the front (left or top). The last is collapsed towards the back. Added in v1.1.0:

instance.collapse(0)

.destroy()

Destroy the instance. It removes the gutter elements, and the size CSS styles Split.js set. Added in v1.1.1.

instance.destroy()

CSS

In being non-opionionated, the only CSS Split.js sets is the widths or heights of the elements. Everything else is left up to you. You must set the elements and gutter heights when using horizontal mode. The gutters will not be visible if their height is 0px. Here's some basic CSS to style the gutters with, although it's not required. Both grip images are included in this repo:

.gutter {
    background-color: #eee;

    background-repeat: no-repeat;
    background-position: 50%;
}

.gutter.gutter-horizontal {
    background-image: url('grips/vertical.png');
    cursor: ew-resize;
}

.gutter.gutter-vertical {
    background-image: url('grips/horizontal.png');
    cursor: ns-resize;
}

The grip images are small files and can be included with base64 instead:

.gutter.gutter-vertical {
    background-image:  url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAFAQMAAABo7865AAAABlBMVEVHcEzMzMzyAv2sAAAAAXRSTlMAQObYZgAAABBJREFUeF5jOAMEEAIEEFwAn3kMwcB6I2AAAAAASUVORK5CYII=')
}

.gutter.gutter-horizontal {
    background-image:  url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAeCAYAAADkftS9AAAAIklEQVQoU2M4c+bMfxAGAgYYmwGrIIiDjrELjpo5aiZeMwF+yNnOs5KSvgAAAABJRU5ErkJggg==')
}

Split.js also works best when the elements are sized using border-box. The split class would have to be added manually to apply these styles:

.split {
  -webkit-box-sizing: border-box;
     -moz-box-sizing: border-box;
          box-sizing: border-box;
}

And for horizontal splits, make sure the layout allows elements (including gutters) to be displayed side-by-side. Floating the elements is one option:

.split, .gutter.gutter-horizontal {
    float: left;
}

If you use floats, set the height of the elements including the gutters. The gutters will not be visible otherwise if the height is set to 0px.

.split, .gutter.gutter-horizontal {
    height: 300px;
}

Overflow can be handled as well, to get scrolling within the elements:

.split {
    overflow-y: auto;
    overflow-x: hidden;
}

Browser Support

This library uses calc(), box-sizing and getBoundingClientRect(). This features are supported in the following browsers:

19+ ✔	4+ ✔	9+ ✔	32+ ✔	7+ ✔

Gracefully falls back in IE 8 and below to only setting the initial widths/heights and not allowing dragging. IE 8 requires a polyfill for Array.isArray() and a polyfill for Object.keys().

License

Copyright (c) 2016 Nathan Cahill

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.