Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datapuzzler/lse-tree-selection
Dependency-free web component enabling consistent interactivity of tree selection views.
https://github.com/datapuzzler/lse-tree-selection
tree-selection vanilla-js web-component
Last synced: about 1 month ago
JSON representation
Dependency-free web component enabling consistent interactivity of tree selection views.
- Host: GitHub
- URL: https://github.com/datapuzzler/lse-tree-selection
- Owner: dataPuzzler
- License: mit
- Created: 2024-08-06T10:36:35.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-11T14:54:32.000Z (3 months ago)
- Last Synced: 2024-10-15T17:34:23.662Z (about 1 month ago)
- Topics: tree-selection, vanilla-js, web-component
- Language: JavaScript
- Homepage:
- Size: 99.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# LSE-TREE-SELECTION
A dependency free web component enabling consistent interactivity of a tree selection view. It's usable both in client- and server side rendering settings (csr & ssr).
# Showcase
[](https://www.youtube.com/watch?v=OWD8yDEvPuw)
## Table of Contents
- [Installation](#installation)
- [HTML-API](#html-api)
- [Event-API](#event-api)
- [Style-API](#style-api)
## Installation
You can install the web component's javascript into your project with your npm-manager of choice.
For example:
```sh
npm install 'lse-tree-selection'
```
Import from the package to make sure its js contents are loaded in places of usage. After that interactivity should work for the introduced HTML tags as defined below.
```js
import * as LseTreeSelection from "lse-tree-selection"
```
## HTML-API
### ``
#### Attributes
| Attribute | Description | Possible Values | Required |
|------------------|-----------------------------------------------------------|-------------------------------|----------------|
| `init-dimension` | Identifier to identify the selection hierarchy uniquely. | A distinctive string | yes |
| `init-data` | Holder of data selection structure in csr-setting | Stringified JSON string, see below | csr only |
The data selection structure is defined as follows in recursive manner:
```javascript
// Leaf Node Example
{
id: 1 // Numeric identifier of selection option, must be unique within the `` instance
label: "Label for option 1" // String that is visually displayed
children: [] // Array that holds objects of the exact structure as defined in this example or is empty in case of Leaf Nodes
}
```
#### Inner-HTML Characteristics
- Empty in csr-etting
- In ssr-setting a structure of nested ``
### ``
If the attribute **init-data** is given in `` as explained above, these nodes are automatically rendered, when the `` DOM node is mounted.
In a ssr-setting the following characterics must be satisfied.
#### Attributes
| Attribute | Description | Possible Values | Required |
|------------------|-----------------------------------------------------------|-------------------------------|----------------|
| `id` | Identifier to identify the selection node uniquely within the lse-tree-selection instance | A numeric identifier | yes |
#### Inner-HTML Characteristics
The Inner-HTML must contain an `` element of type checkbox and with a value that corresponds to the id-attribute of the containing `` DOM node.
## Event-API
With each selection the `` element dispatches a custom *TreeSelectionChangeEvent*.
Hierarchically higher DOM Nodes should listen to `lse-tree-selection-change` to get notified about selection changes as well.
### TreeSelectionChangeEvent
This is a custom Event, whose detail property refers to an object with the following properties
- *dimension_key*: Corresponds to the attribute value `init-dimension` of ``
- *selected_ids* : An Array numbers, that correspond to the selected leaf nodes identifiers of the corresponding selection hierarchy.
## Style-API
The component doesn't make any assumptions about its CSS styling.
As showed in the examples CSS can leverage the high specificity of the introduced selection tags, which should help to define enterprise-wise consistent styling of such components.
The component doesn't make use of any shadow DOM feature.