diff --git a/README.md b/README.md index f0257ddb..8f631821 100644 --- a/README.md +++ b/README.md @@ -112,12 +112,13 @@ All node objects **must** have a unique `value`. This value is serialized into t Individual nodes within the `nodes` property can have the following structure: -| Property | Type | Description | Default | -| -------------- | ------ | ---------------------------------------- | ------- | -| `label` | mixed | **Required**. The node's label. | | -| `value` | mixed | **Required**. The node's value. | | -| `children` | array | An array of child nodes. | `null` | -| `className` | string | A className to add to the node. | `null` | -| `disabled` | bool | Whether the node should be disabled. | `false` | -| `icon` | mixed | A custom icon for the node. | `null` | -| `showCheckbox` | bool | Whether the node should show a checkbox. | `true` | +| Property | Type | Description | Default | +| -------------- | ------ | ------------------------------------------- | ------- | +| `label` | mixed | **Required**. The node's label. | | +| `value` | mixed | **Required**. The node's value. | | +| `children` | array | An array of child nodes. | `null` | +| `className` | string | A className to add to the node. | `null` | +| `disabled` | bool | Whether the node should be disabled. | `false` | +| `icon` | mixed | A custom icon for the node. | `null` | +| `showCheckbox` | bool | Whether the node should show a checkbox. | `true` | +| `isRadioGroup` | bool | Whether the node is a radio group container. | `false` | diff --git a/examples/dist/index.html b/examples/dist/index.html index f5ee6157..6a5835c8 100644 --- a/examples/dist/index.html +++ b/examples/dist/index.html @@ -29,6 +29,7 @@

A simple and elegant checkbox tree for React

Examples

+

Basic Example

@@ -77,6 +78,22 @@

Large Data Example

The checkbox tree is capable of supporting a large number of nodes at once.

+

Radio Group Example

+

+ A parent node can be classified as a "radio group" which means that its child nodes will have + radio buttons instead of checkboxes. This allows mutually exclusive options within the checkbox tree. +

+

+ Note: +

+

+
+