├── LICENSE
├── README.md
├── Sample.html
├── assets
├── down-arrow.svg
├── minus.svg
└── plus.svg
├── comboTreePlugin.js
└── comboTreeStyle.css
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2015 kirlisakal
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
23 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## 1.3.1 Updates
2 |
3 | - Outsource libraries cancelled.
4 | - Refactoring JS and CSS.
5 | - Many bugs resolved on both UI and Functionality sides.
6 |
7 | ## 1.2.1 Updates
8 |
9 | - Filter is fixed & updated.
10 | - icontains.js dependency is deprecated.
11 |
12 | # ComboTree jQuery Plugin v 1.2.1
13 |
14 | ComboTree is a jQuery Plugin which is a combobox item within tree structured data list and multiple/single selection options and more. It has been developed to manage large amount of choices in a combobox and multi selection feature.
15 |
16 | ## Features:
17 |
18 | - Tree structured data list in combobox dropdown menu
19 | - Multiple & Single selection
20 | - Cascade selection (for multiple mode)
21 | - Returns selected item(s) as title or id array
22 | - Filtering (for multiple mode)
23 | - Consumes JSON source
24 | - Key controls are available for both selection and filter inputs.
25 |
26 | ## Dependencies:
27 |
28 | - jQuery
29 |
30 | ## Configurations:
31 |
32 | - **isMultiple**: _{true/false} | default: false_ | decide if it is multiple selection behaviour or single
33 | - **cascadeSelect**: _{true/false} | default: false_ | decide if parent selection should cascade to children in multiple selection
34 | - **source**: _{JSON Data Array}_ | takes source of combobox dropdown menu as a JSON array.
35 | - **selected**: _{JSON Data Array}_ | takes the list of ID's that corespond from the source.
36 | - **collapse**: _{true/false} | default: false_ | makes sub lists collapsed.
37 | - **selectAll**: _{true/false} | default: false_ | decide if use 'select all' feature.
38 |
39 | ## Methods
40 |
41 | - **getSelectedIds()**: Returns selected item(s) id list as array or null. _(i.e. [12, 5, 7], [7], null)_
42 | - **getSelectedNames()**: Returns selected item(s) name list as array or null. _(i.e. ["Piegon", "Cat", "Horse"], ["Lion"], null)_
43 | - **setSource()**: You can initialize ComboTree then set source after your JSON data is retrieved.
44 | - **clearSelection()**: Clear selected items.
45 | - **selectAll()**: select all items.
46 | - **setSelection(selectionIdList)**: Set selected values of combotree by id array or single id parameter. If you want to clear previous selections please use _clearSelection()_ before _setSelection()_. _(i.e. ct1.setSelection([12, 5, 7]) | ct1.setSelection(5)_
47 |
48 | ## Events
49 |
50 | - **onChange(callBackFunction)**: Triggers after selection changes.
51 |
52 | ## Usage
53 |
54 | There should be an input element to apply and a JSON Data source.
55 |
56 | comboTree1 = $('#justAnInputBox').comboTree({
57 | source : SampleJSONData,
58 | isMultiple: true,
59 | cascadeSelect: true,
60 | selected: ['0']
61 | });
62 |
63 | // Array, One title/id, or False value return
64 | var selectedTitles = comboTree1.getSelectedItemsTitle();
65 | var selectedIds = comboTree1.getSelectedItemsId();
66 |
67 | // To remove plugin
68 | comboTree1.destroy();
69 |
70 | ## Source Dataset
71 |
72 | Three parameter are needed: id, title and subs (array).
73 |
74 | Can contain the following options:
75 |
76 | - **isSelectable**: _{true/false} | default: true_ | allows or disallows item to be selected
77 | - **collapse**: _{true/false} | default: false_ | makes sub lists collapsed at start
78 |
79 | var SampleJSONData = [
80 | {
81 | id: 0,
82 | title: 'Horse'
83 | }, {
84 | id: 1,
85 | title: 'Birds',
86 | subs: [
87 | {
88 | id: 10,
89 | title: 'Piegon'
90 | }, {
91 | id: 11,
92 | title: 'Parrot'
93 | }, {
94 | id: 12,
95 | title: 'Owl'
96 | }, {
97 | id: 13,
98 | title: 'Falcon'
99 | }
100 | ]
101 | }, {
102 | id: 2,
103 | title: 'Rabbit'
104 | }, {
105 | id: 3,
106 | title: 'Fox'
107 | }, {
108 | id: 5,
109 | title: 'Cats',
110 | subs: [
111 | {
112 | id: 50,
113 | title: 'Kitty'
114 | }, {
115 | id: 51,
116 | title: 'Bigs',
117 | subs: [
118 | {
119 | id: 510,
120 | title: 'Cheetah'
121 | }, {
122 | id: 511,
123 | title: 'Jaguar'
124 | }, {
125 | id: 512,
126 | title: 'Leopard'
127 | }
128 | ]
129 | }
130 | ]
131 | }, {
132 | id: 6,
133 | title: 'Fish'
134 | }
135 | ];
136 |
137 | ## You can donate to support me
138 |
139 | https://www.blockchain.com/btc/address/15c5AxBVgNxkwaHSTBZMiCV5PL41DKe88v
140 |
--------------------------------------------------------------------------------
/Sample.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
10 | ComboTree jQuery Plugin Demos by Erhan FIRAT
11 |
12 |
30 |
31 |
32 |