React
EditEdit This Document
Demos
Support
Forum
Upgrade Guide
FREE TRIAL
Search results

Getting Started using functional component in React Splitter component

01 Feb 2023 / 3 minutes to read

The following section explains the steps required to build the Splitter component with step-by-step procedure.

Dependencies

The following list of dependencies required to use the Splitter component in your application:

Copied to clipboard
|-- @syncfusion/ej2-layouts
    |-- @syncfusion/ej2-base
|-- @syncfusion/ej2-react-layouts
    |-- @syncfusion/ej2-react-base

Installation and configuration

You can use Create-react-app to setup the applications. To install create-react-app run the following command.

Copied to clipboard
npm install -g create-react-app

Start a new project using create-react-app command as follows

Copied to clipboard
create-react-app quickstart --scripts-version=react-scripts-ts

cd quickstart
Copied to clipboard
create-react-app quickstart

cd quickstart

Install the below required dependency package in order to use the Splitter component in your application.

Copied to clipboard
npm install @syncfusion/ej2-react-layouts --save
  • The Splitter CSS files are available in the ej2-layouts package folder. This can be referred in your application using the following code.

[src/App.css]

Copied to clipboard
@import '../../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../../node_modules/@syncfusion/ej2-layouts/styles/material.css';

Adding Splitter to the project

The Splitter can be initialized through <SplitterComponent> tag-directive with <PanesDirective> and <PaneDirective> as child elements respectively.

Please refer the below code snippet,

Copied to clipboard
import { PaneDirective, PanesDirective, SplitterComponent } from '@syncfusion/ej2-react-layouts';
import * as React from "react";

function App() {
  return (
<div className="App">
<SplitterComponent id="splitter" height="250px" width="600px">
    <PanesDirective>
      <PaneDirective/>
      <PaneDirective/>
      <PaneDirective/>
    </PanesDirective>
</SplitterComponent>
</div>
  );
}

export default App;

After completing the configurations to render the Splitter, use the following command to display the output in your default browser.

Copied to clipboard
npm start

Output will be as follows:

Source
Preview
App.jsx
App.tsx
Copied to clipboard
import { PaneDirective, PanesDirective, SplitterComponent } from '@syncfusion/ej2-react-layouts';
import * as React from "react";
function App() {
    return (<div className="App">
  <SplitterComponent id="splitter" height="250px" width="600px">
    <PanesDirective>
      <PaneDirective />
      <PaneDirective />
      <PaneDirective />
    </PanesDirective>
  </SplitterComponent>
</div>);
}
export default App;
Copied to clipboard
import { PaneDirective, PanesDirective, SplitterComponent } from '@syncfusion/ej2-react-layouts';
import * as React from "react";

function App() {
  return (
<div className="App">
  <SplitterComponent id="splitter" height="250px" width="600px">
    <PanesDirective>
      <PaneDirective/>
      <PaneDirective/>
      <PaneDirective/>
    </PanesDirective>
  </SplitterComponent>
</div>
  );
}

export default App;

Orientation

Splitter supports both Horizontal and Vertical orientation for the panes. By default, it will be rendered in Horizontal orientation. You can change it by using orientation property.

Source
Preview
App.jsx
App.tsx
Copied to clipboard
import { PaneDirective, PanesDirective, SplitterComponent } from '@syncfusion/ej2-react-layouts';
import * as React from "react";
function App() {
    return (<div className="App">
  <SplitterComponent id="splitter-vertical" height="250px" width="50%" orientation={'Vertical'}>
    <PanesDirective>
      <PaneDirective />
      <PaneDirective />
    </PanesDirective>
  </SplitterComponent>
</div>);
}
export default App;
Copied to clipboard
import { PaneDirective, PanesDirective, SplitterComponent } from '@syncfusion/ej2-react-layouts';
import * as React from "react";

function App() {
  return (
<div className="App">
  <SplitterComponent id="splitter-vertical" height="250px" width="50%" orientation = {'Vertical'}>
    <PanesDirective>
      <PaneDirective/>
      <PaneDirective/>
    </PanesDirective>
  </SplitterComponent>
</div>
  );
}

export default App;

Load content to the pane

You can load the pane contents in either HTML element or string types using content property.

For detailed information, refer to the Pane Content section

Source
Preview
App.jsx
App.tsx
Copied to clipboard
import { PaneDirective, PanesDirective, SplitterComponent } from '@syncfusion/ej2-react-layouts';
import * as React from "react";
import { useState } from 'react';
function App() {
    const firstPaneContent = `<div>
  <div className="content">
    <h3 className="h3">HTML</h3>
    <div className="code-preview">
      &lt;<span>!DOCTYPE html&gt;</span>
      <div>&lt;<span>html&gt;</span></div>
      <div>&lt;<span>body&gt;</span></div>
      &lt;<span>div</span> id="custom-image"&gt;
      <div>&lt;<span>img</span> src="src/albert.png"&gt;</div>
      <div>&lt;<span>div</span>&gt;</div>
      <div>&lt;<span>/body&gt;</span></div>
      <div>&lt;<span>/html&gt;</span></div>
    </div>
  </div>
  </div>`;
    const secondPaneContent = `<div>
  <div className="content">
    <h3 className="h3">CSS</h3>
    <div className="code-preview">
    <span>img { </span>
    <div id="code-text">margin:<span>0 auto;</span></div>
    <div id="code-text">display:<span>flex;</span></div>
    <div id="code-text">height:<span>70px;</span></div>
    <span> }</span>
    </div>
  </div>
  </div>`;
    const thirdPaneContent = `<div>
    <div className="content">
      <h3 className="h3">JavaScript</h3>
      <div className="code-preview">
      <span>var</span> image = document.getElementById("custom-image");
      <div>image.addEventListener("click", function() { </div>
        <div>// Code block for click action</div>
      <span> }); </span>
      </div>
    </div>
  </div>`;
    const [pane1Content] = useState(firstPaneContent);
    const [pane2Content] = useState(secondPaneContent);
    const [pane3Content] = useState(thirdPaneContent);
    return (<div className="App">
  <SplitterComponent id="splitter" height="250px" width="550px">
    <PanesDirective>
      <PaneDirective content={pane1Content}/>
      <PaneDirective content={pane2Content}/>
      <PaneDirective content={pane3Content}/>
    </PanesDirective>
  </SplitterComponent>
</div>);
}
export default App;
Copied to clipboard
import { PaneDirective, PanesDirective, SplitterComponent } from '@syncfusion/ej2-react-layouts';
import * as React from "react";
import { useState } from 'react';

function App() {
  const firstPaneContent = `<div>
  <div className="content">
    <h3 className="h3">HTML</h3>
    <div className="code-preview">
      &lt;<span>!DOCTYPE html&gt;</span>
      <div>&lt;<span>html&gt;</span></div>
      <div>&lt;<span>body&gt;</span></div>
      &lt;<span>div</span> id="custom-image"&gt;
      <div>&lt;<span>img</span> src="src/albert.png"&gt;</div>
      <div>&lt;<span>div</span>&gt;</div>
      <div>&lt;<span>/body&gt;</span></div>
      <div>&lt;<span>/html&gt;</span></div>
    </div>
  </div>
  </div>`;

  const secondPaneContent = `<div>
  <div className="content">
    <h3 className="h3">CSS</h3>
    <div className="code-preview">
    <span>img { </span>
    <div id="code-text">margin:<span>0 auto;</span></div>
    <div id="code-text">display:<span>flex;</span></div>
    <div id="code-text">height:<span>70px;</span></div>
    <span> }</span>
    </div>
  </div>
  </div>`;

  const thirdPaneContent = `<div>
    <div className="content">
      <h3 className="h3">JavaScript</h3>
      <div className="code-preview">
      <span>var</span> image = document.getElementById("custom-image");
      <div>image.addEventListener("click", function() { </div>
        <div>// Code block for click action</div>
      <span> }); </span>
      </div>
    </div>
  </div>`;

  const [pane1Content] = useState(firstPaneContent);
  const [pane2Content] = useState(secondPaneContent);
  const [pane3Content] = useState(thirdPaneContent);

  return (
<div className="App">
  <SplitterComponent id="splitter" height="250px" width="550px">
    <PanesDirective>
      <PaneDirective content={pane1Content} />
      <PaneDirective content={pane2Content} />
      <PaneDirective content={pane3Content} />
    </PanesDirective>
  </SplitterComponent>
</div>
  );
}

export default App;

See Also

Previous
Next