React UI Components Documentation

ReactJS Docking Component

The Docking component for ReactJS represents a widget which allows you to manage multiple windows and even the layout of your web page.
Each window in the Docking can be dragged around the Web page, docked into docking zones, removed from the docking, collapsed into a minimized state to hide its content, expanded to display its content or pinned in place.

Prerequisites

Refer to ReactJS Getting Started before you start with this help topic.

Configuration

The Docking component for ReactJS requires the following imports.

 
import React from 'react';
import ReactDOM from 'react-dom';
 
import JqxDocking from 'jqwidgets-react/react_jqxdocking.js';

Then we create our component class. Properties and methods are put as ReactJS props.

  
class App extends React.Component {
  render () {
    return (
        <JqxDocking ref='Docking'
                width={800} 
                mode={'docked'}
                orientation={'horizontal'}>
            <div>
                <div id="window1" style={{ height: 220 }}>  
                </div>
                <div id="window2" style={{ height: 220 }}>     
                </div>
            </div>
            <div>
                <div id="window3" style={{ height: 220 }}>
                </div>
                <div id="window4" style={{ height: 220 }}>
                </div>
            </div>
        </JqxDocking>
    )
  }
}

Finally we render our class in the desired HTML element:

 
ReactDOM.render(<App />, document.getElementById('app'));

Events Methods & Properties

In order to bind to any event, change any property or call any method, we need a reference to the component.
For that we use the ReactJS "ref" Callback Attribute:

 
<JqxDocking ref='myDocking' width={800}..... />

Now, when we have a reference, we need to call the desired event/property/method.
This is done in the componentDidMount() ReactJS Component Lifecycle method.

 
class App extends React.Component {
  componentDidMount()
  {
     //your logic
  }
  render ()
  {
    return
    (
      ....
    )
  }
};

Events

The dragStart event is triggered when the user start to drag any window.

The following example demonstrates how to add an event listener:

 
componentDidMount ()
{
 
  this.refs.myDocking.on('dragStart', (event) =>
  {
     //your logic
  });
 
}

Methods & Properties

This is how you call methods & props:

Every component have a method setOptions which accepts a object as an argument. This object contains component settings.

Every component also have a method getOptions which returns a object containing the component settings.