react-kendo

0.13.11 • Public • Published

react-kendo

npm version Build status Dependency Status

React Component Library for Kendo UI Widgets. There exists a React Component named for every Kendo widget in the kendo.ui namespace. Tested on React 0.13 and KendoUI 2014.3.1411.

Install

$ npm install react-kendo --save
  <script src="http://cdn.kendostatic.com/2014.3.1411/js/kendo.all.min.js"></script> 
  <link href='http://cdn.kendostatic.com/2014.3.1411/styles/kendo.common.min.css' rel='stylesheet'>
  <!-- and so forth... -->

Please note: Kendo Professional Components require a License.

Usage

var React = require('react');
var k = React.Kendo = require('react-kendo');
 
/**
 * Instead of, e.g.
 * $('#my-splitter').kendoSplitter(splitterOptions);
 */
var splitterOptions = {
  orientation: 'horizontal',
  panes: [
    { collapsible: false, size: '300px' },
    { resizable: true }
  ]
};
var treeOptions = { /* ... */ };
var gridOptions = { /* ... */ };
 
var Workstation = React.createClass({
  render: function () {
    return (
      <k.Splitter options={splitterOptions}>
        <k.TreeView options={treeOptions} />
        <k.Grid options={gridOptions} />
      </k.Splitter>
    );
  }
});

Properties

options

The main Kendo options object that is sent into the constructor. e.g. $('#my-splitter').kendoSplitter(options);

tag

The tag property specifies the html tag that the Kendo widget will be bound to. This is div by default, but can be set to any tag supported by React.

reactive

Version 0.13 and later support automatically re-initializing the Kendo Widget when the options property is updated. This is useful for re-loading Grids with new data, among other things. This is false by default.

debug

Set debug=true to log detailed information on the lifecycle events of your react-kendo component.

Additional Components

React.Kendo.Template

A React Component that represents a Kendo Template. Easily create a Kendo Template from a React Component. Additionally mixin React.Kendo.TemplateMixin.

var k = React.Kendo;
var MyListItem = React.createClass({
  mixins: [
    k.TemplateMixin
  ],
  render: function () {
    var item = this.props.item;
    return (
      <span>{item.title}</span>
    );
  }
});
var KendoList = React.createClass({
  render: function () {
    return (
      <k.ListView options={
        template: function (item) {
          return k.Template(<MyListItem item={item} />);
        }
      } />
    );
  }
});

React.Kendo.RowTemplate

Use this component for Kendo Grid Row Templates.

var MyGridRow = React.createClass({
  mixins: [
    k.TemplateMixin
  ],
  render: function () {
    var row = this.props.row;
    return (
      <span>{row.myField}</span>
    );
  }
});
var KendoList = React.createClass({
  render: function () {
    return (
      <k.Grid options={
        template: function (row) {
          return k.RowTemplate(<MyGridRow row={row} />);
        }
      } />
    );
  }
});

Supplemental Functions

react-kendo also includes some extra functionality that isn't included in Kendo. These functions are added to the Kendo components via React mixins.

Grid.enableDraggableRows(group, options)

Invoke this function to make Grid rows draggable. This is not possible by default in the kendo-ui library.

var k = React.Kendo;
var KendoList = React.createClass({
  componentDidMount: function () {
    this.refs.grid.enableDraggableRows('myGroup', {
      drag: function (e) {
        // some custom stuff
      }
    });
  },
  render: function () {
    return (
      <k.Grid ref='grid' options={...} />
    );
  }
});

License

MIT

Package Sidebar

Install

npm i react-kendo

Weekly Downloads

190

Version

0.13.11

License

MIT

Last publish

Collaborators

  • tjwebb