React UI Components Documentation

Typescript React Grid Component

This tutorial will show you the basics of how to get started with the jQWidgets Grid React Component.

Prerequisites

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

Structure

I. Imports:


import * as React from 'react';
 
import 'jqwidgets-scripts/jqwidgets/styles/jqx.base.css';
import 'jqwidgets-scripts/jqwidgets/styles/jqx.material-purple.css';
import JqxGrid, { IGridProps } from 'jqwidgets-scripts/jqwidgets-react-tsx/jqxgrid';

II. Class:


class App extends React.PureComponent<{}, IGridProps> {
    constructor(props: {}) {
        super(props);
 
        this.state = {
            width: '100%'
            // Other Widget Props
        }
    }
   
    render() {
        return (
            <JqxGrid 
                width={this.state.width} height={"100%"} .....
            />
        )
    }
}

III. Render:


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

Events

The event names in React are constructed of the original event names starting with capital letter plus on upfront:


class App extends React.PureComponent<{}, IGridProps> {
    constructor(props: {}) {
        super(props);
 
        this.state = {
            width: '100%'
            // Other Widget Props
        }
    }
   
    render() {
        return (
            <JqxGrid onNameOfEvent={this.handleEvent}
                width={this.state.width} height={"100%"} .....
            />
        )
    }
 
    private handleEvent(e: Event): void {
        // Do Something ...
    }
}

Methods & Properties

This is how you call methods & props:


//Get Methods
const value = this.myGrid.current!.methodName(arg1, arg2);
 
//Set Methods
this.myGrid.current!.methodName(arg1, arg2);
 
//Get Properties
const height = this.state.height;
 
//Set Properties
this.setState({ height: 250 });

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


this.myGrid.current!.setOptions({ width: 350, height: 400 });

Every component also have a method getOptions which returns the value of the requested option.


const width = this.myGrid.current!.getOptions('width');

Grid API

API Reference of the jQWidgets Grid React Component: Grid API

Grid Demos

Demos Reference of the jQwidgets Grid React Component: Grid Demos