Skip to content

Commit 2e588f5

Browse files
authored
Merge pull request #114 from grapoza/fix-docs-for-skins
Fixes skins docs
2 parents 9bf756e + 99434b9 commit 2e588f5

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docsrc/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Features include:
1717
- Radio buttons
1818
- Addition and removal of nodes
1919
- Slots for node content
20+
- Skinning
2021
- Follows ARIA guidelines for treeview accessibility
2122

2223
Planned:
@@ -101,9 +102,10 @@ To see it in action, try out the [demos](demos.html).
101102

102103
| Prop | Type | Description | Default value | Required |
103104
|:-----------------|:---------|:-------------------------------------------------------------------------------------|:----------------------------------|:---------|
104-
| initialModel | Array | The data model containing [model data](#model-data) | - | Yes |
105+
| initialModel | Array | The data model containing [model data](#model-data) | - | Yes |
105106
| modelDefaults | Object | An object containing defaults for all nodes that do not specify the given properties | `{}` | |
106107
| radioGroupValues | Object | An object, the properties of which correspond to radio button group selections | `{}` | |
108+
| skinClass | String | A class name to apply to the tree that specifies a skin to use (see [Skins](#skins)) | `"default-tree-view-skin"` | |
107109
| customAriaKeyMap | Object | An object, the properties of which are arrays to keyCodes for various actions | See [Aria](#setting-key-bindings) | |
108110

109111
## Model Data
@@ -279,6 +281,10 @@ A customizations object may have the following properties:
279281
| classes.treeViewNodeSelfDeleteIcon | String | Classes to add to the `<i>` element containing the delete icon |
280282
| classes.treeViewNodeChildren | String | Classes to add to the list of child nodes |
281283

284+
### Skins
285+
286+
If adding classes isn't enough, the entire default styles of the TreeView can be overridden using the `skinClass` property of the TreeView. When this property is set, the TreeView's default class of `default-tree-view-skin` is replaced with your own class name, causing all of the built-in style selectors to not match the tree. Instead, you can create your own stylesheet or modify a copy of the default styles to achieve complete control over the tree styling.
287+
282288
### Slots
283289

284290
Sometimes the entire content of a node (_e.g._, the checkbox or text) needs customization beyond what is available through classes. In this case, some slots are available in the TreeView to allow this customization.

0 commit comments

Comments
 (0)