React UI Components Documentation

React DockPanel Component

The DockPanel component for React represents a container for other widgets or elements.
It arranges its inner elements depending on the value of the 'dock' attribute. The possible 'dock' attribute values are: 'left, right, top and bottom'.

Prerequisites

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

Configuration

The DockPanel component for React requires the following imports.

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

Finally we render our class in the desired HTML element:

Events & 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 React "ref" Callback Attribute:

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

Events

The layout event occurs when the layout is performed.

The following example demonstrates how to add an event listener:

Properties

This is how you call 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.

DockPanel Examples

Overview

The following example demonstrates how to create a DockPanel component.

DockPanel API

API Reference of the jQWidgets DockPanel component for React: DockPanel API