carbon-react/lib/components/table/table-row/definition.js

A library of reusable React components and an interface for easily building user interfaces based on Flux.

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _ = require('./');

var _2 = _interopRequireDefault(_);

var _definition = require('./../../../../demo/utils/definition');

var _definition2 = _interopRequireDefault(_definition);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

var definition = new _definition2.default('table-row', _2.default, {
  propTypes: {
    as: "String",
    children: "Node",
    className: "String",
    hideMultiSelect: "Boolean",
    highlightable: "Boolean",
    highlighted: "Boolean",
    onClick: "Function",
    onHighlight: "Function",
    onSelect: "Function",
    selectAll: "Boolean",
    selectable: "Boolean",
    selected: "Boolean",
    uniqueID: "String"
  },
  propDescriptions: {
    as: "Defines what this row is for. For your header row set this to 'header' to ensure it behaves correctly.",
    children: "This component supports children.",
    className: "Classes to apply to the component.",
    hideMultiSelect: "Option to hide the checkbox for a row that is selectable. Useful if you have set your table to be selectable but you do not want a particular row to be selectable.",
    highlightable: "Controls if this particular row is highlightable.",
    highlighted: "Controls the highlighted state of the row.",
    onClick: "Callback called after the row is clicked.",
    onHighlight: "Triggered when a row is highlighted.",
    onSelect: "Triggered when a row is selected.",
    selectAll: "Defines if the row's checkbox should be used to select all rows.",
    selectable: "Controls if this particular row is selectable.",
    selected: "Controls the selected state of the row.",
    uniqueID: "A unique ID should be provided if using selectable/highlightable rows - this is used to track the selected/highlighted as rows are unmounted from the DOM."
  }
});

exports.default = definition;