React Splitter - 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

collapsed

Specifies whether an item (pane) is initially collapsed.

Type:

Boolean

Default Value: false
NOTE
Splitter should have at least one non-collapsed pane without a set size.

collapsedSize

Specifies the size of a collapsible item (pane) when collapsed in pixels or as a percentage.

Type:

Number

|

String

| undefined
Default Value: undefined
jQuery
index.js
$(() => {
    $("#splitter").dxSplitter({
        items: [
            {
                // ...
                collapsedSize: "20px",
            }
        ],
    });
});
Angular
app.component.html
<dx-splitter ... >
    <dxi-splitter-item ...
        collapsedSize="20px"
    >
    </dxi-splitter-item>
</dx-splitter>
Vue
App.vue
<template>
    <DxSplitter ... >
        <DxItem ... 
            collapsedSize="20px"
        />
    </DxSplitter>
</template>

<script setup>
import { DxSplitter, DxItem } from "devextreme-vue/splitter";
</script>
React
App.js
import React from "react";
import Splitter, { Item } from "devextreme-react/splitter";

const App = () => (
    <React.Fragment>
        <Splitter ... >
            <Item ... 
                collapsedSize="20px"
            />
        </Splitter>
    </React.Fragment>
);

export default App;
NOTE
The collapsedSize value must not exceed maxSize or be less then minSize.

View Demo

collapsible

Specifies whether an item (pane) is collapsible.

Type:

Boolean

Default Value: false

Splitter with collapsible panes

To collapse a pane, you can also double-click the separator bar.

NOTE
Splitter should have at least one non-collapsed pane without a set size.

View Demo

component

An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

maxSize

Specifies the maximum size of an item (pane) in pixels or as a percentage.

Type:

Number

|

String

| undefined
Default Value: undefined
jQuery
index.js
$(() => {
    $("#splitter").dxSplitter({
        items: [
            {
                // ...
                maxSize: "500px",
            }
        ],
    });
});
Angular
app.component.html
<dx-splitter ... >
    <dxi-splitter-item ...
        maxSize="500px"
    >
    </dxi-splitter-item>
</dx-splitter>
Vue
App.vue
<template>
    <DxSplitter ... >
        <DxItem ... 
            maxSize="500px"
        />
    </DxSplitter>
</template>

<script setup>
import { DxSplitter, DxItem } from "devextreme-vue/splitter";
</script>
React
App.js
import React from "react";
import Splitter, { Item } from "devextreme-react/splitter";

const App = () => (
    <React.Fragment>
        <Splitter ... >
            <Item ... 
                maxSize="500px"
            />
        </Splitter>
    </React.Fragment>
);

export default App;

View Demo

minSize

Specifies the minimum size of an item (pane) in pixels or as a percentage.

Type:

Number

|

String

| undefined
Default Value: undefined
jQuery
index.js
$(() => {
    $("#splitter").dxSplitter({
        items: [
            {
                // ...
                minSize: "30%",
            }
        ],
    });
});
Angular
app.component.html
<dx-splitter ... >
    <dxi-splitter-item ...
        minSize="30%"
    >
    </dxi-splitter-item>
</dx-splitter>
Vue
App.vue
<template>
    <DxSplitter ... >
        <DxItem ... 
            minSize="30%"
        />
    </DxSplitter>
</template>

<script setup>
import { DxSplitter, DxItem } from "devextreme-vue/splitter";
</script>
React
App.js
import React from "react";
import Splitter, { Item } from "devextreme-react/splitter";

const App = () => (
    <React.Fragment>
        <Splitter ... >
            <Item ... 
                minSize="30%"
            />
        </Splitter>
    </React.Fragment>
);

export default App;

View Demo

render

An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

resizable

Specifies whether an item (pane) is resizable.

Type:

Boolean

Default Value: true

Splitter with resizable panes

View Demo

size

Specifies the initial size of an item (pane) in pixels or as a percentage of the component's total size. The Splitter initializes panes with equal sizes when this property is undefined (default).

Type:

Number

|

String

| undefined
Default Value: undefined

Splitter preserves configured pane sizes across UI layout changes. If you update the component layout programmatically (modify an item's size property using option()), Splitter recalculates the sizes of all panes. This may shift the entire component layout. To prevent unintended changes to other panes, define size for every pane and reassign all pane sizes when you update the layout.

NOTE
  • Specify minSize and maxSize to limit pane sizes.
  • Ensure the combined size of all panes does not exceed Splitter dimensions to avoid truncated or hidden pane content.
jQuery
index.js
$("#splitter").dxSplitter({
    items: [{
        size: "50%",
    }, /* ... */ ],
});
Angular
app.component.html
<dx-splitter>
    <dxi-splitter-item
        size="50%"
    ></dxi-splitter-item>
</dx-splitter>
Vue
App.vue
<template>
    <DxSplitter>
        <DxItem 
            size="50%"
        />
    </DxSplitter>
</template>

<script setup lang="ts">
import { DxSplitter, DxItem } from "devextreme-vue/splitter";
</script>
React
App.tsx
import React from "react";
import { Splitter, Item } from "devextreme-react/splitter";

export default function App() {
    return (
        <Splitter>
            <Item
                size="50%"
            />
        </Splitter>
    );
}

View Demo

splitter

Specifies a splitter inside an item (pane).

Type: dxSplitter_Options | undefined
Default Value: undefined

Use this property to make the item a nested Splitter UI component.

Splitter with a nested splitter

jQuery
index.js
$(() => {
    $("#splitter").dxSplitter({
        orientation: "vertical",
        items: [{
                text: "Top Panel"
            },
            {
                splitter: {
                    items: [{
                            text: "Nested Left Panel"
                        },{
                            text: "Nested Central Panel"
                        },{
                            text: "Nested Right Panel"
                        }
                    ]
                }
            }
        ]
    });
});
Angular
app.component.html
<dx-splitter id="splitter" orientation="vertical">
    <dxi-splitter-item text="Top Panel"></dxi-splitter-item>
    <dxi-splitter-item>
        <dx-splitter>
            <dxi-splitter-item text="Nested Left Panel"></dxi-splitter-item>
            <dxi-splitter-item text="Nested Central Panel"></dxi-splitter-item>
            <dxi-splitter-item text="Nested Right Panel"></dxi-splitter-item>
        </dx-splitter>
    </dxi-splitter-item>
</dx-splitter>
Vue
App.vue
<template>
    <DxSplitter class="splitter" orientation="vertical">
        <DxItem text="Top Panel" />
        <DxItem>
            <DxSplitter>
                <DxItem text="Nested Left Panel" />
                <DxItem text="Nested Central Panel" />
                <DxItem text="Nested Right Panel" />
            </DxSplitter>
        </DxItem>
    </DxSplitter>
</template>

<script setup>
import { DxSplitter, DxItem } from "devextreme-vue/splitter";
</script>
React
App.js
import React from "react";
import Splitter, { Item } from "devextreme-react/splitter";

const App = () => (
    <React.Fragment>
        <Splitter orientation="vertical">
            <Item text="Top Panel" />
            <Item>
                <Splitter>
                    <Item text="Nested Left Panel" />
                    <Item text="Nested Central Panel" />
                    <Item text="Nested Right Panel" />
                </Splitter>
            </Item>
        </Splitter>
    </React.Fragment>
);

export default App;

View Demo

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data:

CollectionWidgetItem

The item object to be rendered.

jQuery

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.

The following example adds a custom item to the component.

index.js
$(function() {
    $("#splitterContainer").dxSplitter({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});
Angular

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Angular uses custom templates instead of the template property.

app.component.html
app.component.ts
app.module.ts
<dx-splitter ... >
    <dxi-splitter-item ... >
        <div *dxTemplate>
            <div>Custom Item</div>
        </div>
    </dxi-splitter-item>
</dx-splitter>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
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

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Vue uses custom templates instead of the template property.

App.vue
<template>
    <DxSplitter ... >
        <dxItem ... >
            <div>Custom Item</div>
        </dxItem>
    </DxSplitter>
</template>

<script>

import DxSplitter, {
    DxItem
} from 'devextreme-vue/splitter';

export default {
    components: {
        DxSplitter,
        DxItem
    },
    // ...
}
</script>
React

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. In React, specify the render or component properties.

App.js
import React from 'react';

import Splitter, {
    Item
} from 'devextreme-react/splitter';

const renderCustomItem = () => {
    return <div>Custom Item</div>;
}

const App() = () => {
    return (
        <Splitter ... >
            <Item ...
                render={renderCustomItem}
            >
            </Item>
        </Splitter>
    );
}
export default App;
See Also

text

Specifies text displayed for the UI component item.

Type:

String

If you use both this property and a template, the template overrides the text.

visible

Specifies whether or not a UI component item must be displayed.

Type:

Boolean

Default Value: true

When you set this property to true at runtime, displayed pane size becomes 0. Update other pane sizes to display the pane.