diff --git a/README.md b/README.md index 0e61081..8d968d1 100644 --- a/README.md +++ b/README.md @@ -15,24 +15,25 @@ There is an [issue](https://github.com/eidng8/vue-tree/issues/24) for this. Chec ## Props -| Prop name | Description | Type | Default | -| --- | --- | :-: | :-: | -| item-id | Key of the field in `item` to be used as element's `id` attribute. | string | 'id' | -| item-label | Key of the field in `item` that holds node label. | string | 'name' | -| tags-key | Key of the field in `item` that holds tags array. | string | 'tags' | -| children-key | Key of the field in `item` that holds child nodes array. | string | 'children' | -| tag-id | Key of the field in tags list of `item` to be used as tag element's `id` attribute. | string | 'id' | -| tag-label | Key of the field in tags list of `item` that holds tag label. | string | 'label' | -| tag-hint | Key of the field in tags list of `item` that holds tag tooltip. | string | 'hint' | -| checker | Whether to add a checkbox before each item,
allowing multiple nodes tobe checked. | boolean | false | -| item | The tree data to be rendered.
Please note that data passed **_may_** be mutated by this
component to reflect various states of tree nodes.
Mutated fields include:
- checked
- intermediate
- rendered | [G8TreeItem](#g8treeitem) | | + +| Prop name | Description | Type | Default | +| ------------ | ------------------------------------------------------------------------------------ | :-----: | :--------: | +| item-id | Key of the field in `item` to be used as element's `id` attribute. | string | 'id' | +| item-label | Key of the field in `item` that holds node label. | string | 'name' | +| tags-key | Key of the field in `item` that holds tags array. | string | 'tags' | +| children-key | Key of the field in `item` that holds child nodes array. | string | 'children' | +| tag-id | Key of the field in tags list of `item` to be used as tag element's `id` attribute. | string | 'id' | +| tag-label | Key of the field in tags list of `item` that holds tag label. | string | 'label' | +| tag-hint | Key of the field in tags list of `item` that holds tag tooltip. | string | 'hint' | +| checker | Whether to add a checkbox before each item,
allowing multiple nodes tobe checked. | boolean | false | +| item | The tree data to be rendered.
Please note that data passed **_may_** be mutated by this
component to reflect various states of tree nodes.
Mutated fields include:
- checked
- intermediate
- rendered | [G8TreeItem](#g8treeitem) | | ## Scoped slots #### Default slot ```vue - + {{ item[itemLabel] }} ``` @@ -43,7 +44,7 @@ This is the entry's main content slot. Defaults to `{{ item[itemLabel] }}`. The ```vue