JavaScript/jQuery Splitter Options

An object that defines configuration properties for the Splitter UI component.

allowKeyboardNavigation

Specifies whether to allow the Splitter to take focus and allow keyboard navigation.

Type:

Boolean

Default Value: true

dataSource

Binds the UI component to data.

Type:

String

|

Array<dxSplitterItem>

|

Store

|

DataSource

|

DataSource Configuration

| null
Default Value: null

Splitter works with collections of objects or string values.

Depending on your data source, bind Splitter to data as follows.

  • Data Array
    Assign the array to the dataSource option.

  • Read-Only Data in JSON Format
    Set the dataSource property to the URL of a JSON file or service that returns JSON data.

  • OData
    Implement an ODataStore.

  • Web API, PHP, MongoDB
    Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

    Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

    jQuery
    JavaScript
    $(function() {
        let serviceUrl = "https://url/to/my/service";
        $("#splitterContainer").dxSplitter({
            // ...
            dataSource: DevExpress.data.AspNet.createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            })
        })
    });
    Angular
    app.component.ts
    app.component.html
    app.module.ts
    import { Component } from '@angular/core';
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        store: CustomStore;
        constructor() {
            let serviceUrl = "https://url/to/my/service";
            this.store = createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            })
        }
    }
    <dx-splitter ...
        [dataSource]="store">
    </dx-splitter>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxSplitterModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxSplitterModule
        ],
        providers: [],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template> 
        <DxSplitter ...
            :data-source="store" />
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.light.css';
    
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    import { DxSplitter } from 'devextreme-vue/splitter';
    
    export default {
        components: {
            DxSplitter
        },
        data() {
            const serviceUrl = "https://url/to/my/service";
            const store = createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            });
            return {
                store
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    import 'devextreme/dist/css/dx.light.css';
    
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    import Splitter from 'devextreme-react/splitter';
    
    const serviceUrl = "https://url/to/my/service";
    const store = createStore({
        key: "ID",
        loadUrl: serviceUrl + "/GetAction",
        insertUrl: serviceUrl + "/InsertAction",
        updateUrl: serviceUrl + "/UpdateAction",
        deleteUrl: serviceUrl + "/DeleteAction"
    });
    
    class App extends React.Component {
        render() {
            return (
                <Splitter ...
                    dataSource={store} />
            );
        }
    }
    export default App;
  • Any other data source
    Implement a CustomStore.

Regardless of the data source on the input, the Splitter always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

NOTE

Review the following notes about data binding:

  • Do not specify the items property if you specified the dataSource, and vice versa.

  • Data field names cannot be equal to this and should not contain the following characters: ., :, [, and ].

jQuery
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.
Angular
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
Vue
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
React
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#splitterContainer").dxSplitter({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-splitter ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-splitter>
import { DxSplitterModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSplitterModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxSplitter ...
        :element-attr="splitterAttributes">
    </DxSplitter>
</template>

<script>
import DxSplitter from 'devextreme-vue/splitter';

export default {
    components: {
        DxSplitter
    },
    data() {
        return {
            splitterAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import Splitter from 'devextreme-react/splitter';

class App extends React.Component {
    splitterAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Splitter ...
                elementAttr={this.splitterAttributes}>
            </Splitter>
        );
    }
}
export default App;

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: undefined

This property accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

items[]

An array of items (panes) displayed by the UI component.

Type:

Array<dxSplitterItem>

Raised Events: onOptionChanged

The items array can contain:

  • Objects with fields described in this section.
  • Objects with any other fields. In this case, specify the itemTemplate.

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores supply an API that allows you to update individual items without reassigning the entire item collection.

NOTE
Do not use the items property if you use dataSource, and vice versa.

View Demo

itemTemplate

Specifies a custom template for items.

Type:

template

Template Data:

Object

The item object to be rendered.

Default Name: 'item'

The following code snippet demonstrates itemTemplate usage. Panes have random background colors, and their content includes an order number.

jQuery
index.js
$(() => {
    $("#splitter").dxSplitter({
        items: [
            // ...
        ],
        itemTemplate: function (data, index, element) {
            let randomColor = "#" + Math.floor(Math.random()*16777215).toString(16);
            $(element).css('background-color', randomColor);
            return index + 1;
        }
    });
});
Angular
app.component.html
app.component.ts
<dx-splitter itemTemplate="item">
    <dxi-item ...></dxi-item>
    <dxi-item ...></dxi-item>
    <div
        *dxTemplate="let data of 'item'; let index = index" 
        [style.background-color]="getRandomColor()"
    >
        {{index + 1}}
    </div>
</dx-splitter>
export class AppComponent {
    constructor() {
        // ...
    }

    getRandomColor() {
        return "#" + Math.floor(Math.random() * 16777215).toString(16);
    }
}
Vue
App.vue
<template>
    <DxSplitter item-template="item">
        <DxItem ... />
        <DxItem ... />
        <template #item="{ data, index }">
            <div :style="{ backgroundColor: getRandomColor() }">{{ index + 1 }}</div>
        </template>
    </DxSplitter>
</template>

<script setup>
import { DxSplitter, DxItem } from "devextreme-vue/splitter";
const getRandomColor = () => {
    return "#" + Math.floor(Math.random() * 16777215).toString(16);
};
</script>
React
App.js
import React from "react";
import Splitter, { Item } from "devextreme-react/splitter";

const itemRender = (data, index) => {
    return (
        <div style={{ backgroundColor: getRandomColor(), height: "100%" }}>
            {index + 1}
        </div>
    );
};

const getRandomColor = () => {
    return "#" + Math.floor(Math.random() * 16777215).toString(16);
};

const App = () => (
    <React.Fragment>
        <Splitter itemRender={itemRender}>
            <Item ... />
            <Item ... />
        </Splitter>
    </React.Fragment>
);

export default App;
See Also

onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component Splitter

The UI component's instance.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component Splitter

The UI component's instance.

Default Value: null

onInitialized

A function used to save the UI component instance.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component Splitter

The UI component's instance.

Default Value: null

Angular
app.component.html
app.component.ts
<dx-splitter ...
    (onInitialized)="saveInstance($event)">
</dx-splitter>
import { Component } from "@angular/core";
import Splitter from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    splitterInstance: Splitter;
    saveInstance (e) {
        this.splitterInstance = e.component;
    }
}
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <div>
        <DxSplitter ...
            @initialized="saveInstance">
        </DxSplitter>
    </div>
</template>

<script>
import DxSplitter from 'devextreme-vue/splitter';

export default {
    components: {
        DxSplitter
    },
    data: function() {
        return {
            splitterInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.splitterInstance = e.component;
        }
    }
};
</script>
<template>
    <div>
        <DxSplitter ...
            @initialized="saveInstance">
        </DxSplitter>
    </div>
</template>

<script setup>
import DxSplitter from 'devextreme-vue/splitter';

let splitterInstance = null;

const saveInstance = (e) => {
    splitterInstance = e.component;
}
</script>
React
App.js
import Splitter from 'devextreme-react/splitter';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.splitterInstance = e.component;
    }

    render() {
        return (
            <div>
                <Splitter onInitialized={this.saveInstance} />
            </div>
        );
    }
}
See Also
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onItemClick

A function that is executed when an item (pane) is clicked or tapped.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

The clicked item's index.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemData

Object

The clicked item's data.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

The UI component's container.

component Splitter

The UI component's instance.

Default Value: null

onItemCollapsed

A function that is executed after an item (pane) is collapsed.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component Splitter

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

itemData

Object

The collapsed item's data.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemIndex

Number

The collapsed item's index.

Default Value: null

onItemContextMenu

A function that is executed when an item (pane) is right-clicked or pressed.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

The item's index.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemData

Object

The item's data.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component Splitter

The UI component's instance.

Default Value: null

onItemExpanded

A function that is executed after an item (pane) is expanded.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component Splitter

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

itemData

Object

The expanded item's data.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemIndex

Number

The expanded item's index.

Default Value: null

onItemRendered

A function that is executed after an item (pane) is rendered.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

The rendered item's index.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemData

Object

The rendered item's data.

element

HTMLElement | jQuery

The UI component's container.

component Splitter

The UI component's instance.

Default Value: null

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.

previousValue any

The UI component's previous value.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

fullName

String

The path to the modified property that includes all parent properties.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component Splitter

The UI component's instance.

Default Value: null

The following code snippet shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#splitterContainer").dxSplitter({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-splitter ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-splitter>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxSplitterModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxSplitterModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  
Vue
App.vue
<template> 
    <DxSplitter ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxSplitter from 'devextreme-vue/splitter'; 

export default { 
    components: { 
        DxSplitter
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 
React
App.js
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Splitter from 'devextreme-react/splitter'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Splitter ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

onResize

A function that is executed each time an item (pane) is resized by one pixel.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel the resize operation.

component Splitter

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

handleElement

HTMLElement | jQuery

A resize handle element.

Default Value: null

onResizeEnd

A function that is called when resizing ends.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component Splitter

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

handleElement

HTMLElement | jQuery

A resize handle element.

Default Value: null

onResizeStart

A function that is called when resizing starts.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel resize operation.

component Splitter

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

handleElement

HTMLElement | jQuery

A resize handle element.

Default Value: null

orientation

Specifies item orientation (layout).

Type:

Orientation

Default Value: 'horizontal'

The following image shows horizontal and vertical Splitter orientations:

Splitter with horizontal and vertical orientations

View Demo

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

Boolean

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

separatorSize

Specifies the size of a separator bar in pixels.

Type:

Number

Default Value: 8

visible

Specifies whether the UI component is visible.

Type:

Boolean

Default Value: true

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

This property accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.