2323
2424Features:
2525
26- * Support string arguments.
27- * Support number arguments.
28- * Support object arguments.
29- * Support array arguments.
30- * Support function arguments.
31- * No dependency.
26+ - Support string arguments.
27+ - Support number arguments.
28+ - Support object arguments.
29+ - Support array arguments.
30+ - Support function arguments.
31+ - No dependency.
3232
3333## Quickstart - CommonJS
3434
@@ -44,73 +44,76 @@ yarn add dynamic-class-list
4444
4545Then require it in your module ...
4646
47-
4847``` javascript
49- var getClassNames = require (' dynamic-class-list' ).getClassNames ; // deprecated
50- var classList = require (' dynamic-class-list' ).classList ;
48+ var cl = require (' dynamic-class-list' ).cl ;
5149```
5250
5351## OR using ES6 imports
5452
55-
5653``` javascript
57- import { getClassNames , classList } from ' dynamic-class-list' ;
54+ import { cl } from ' dynamic-class-list' ;
5855```
5956
60- Note that ` getClassNames ` is deprecated and will be removed in next major release. You should use ` classList ` moving forward.
61-
6257## API
6358
6459### Arguments as strings
6560
6661``` javascript
67-
6862// As Arguments
69- getClassNames (' class1' , ' class2' ); // Output ==> "class1 class2"
70- // OR
71- classList (' class1' , ' class2' ); // Output ==> "class1 class2"
63+ cl (' class1' , ' class2' ); // Output ==> "class1 class2"
7264```
7365
7466### Arguments as an array of strings
7567
76-
7768``` javascript
78- classList ([' class1' , ' class2' ]); // Output ==> "class1 class2"
69+ cl ([' class1' , ' class2' ]); // Output ==> "class1 class2"
7970
80- classList ([null , undefined , 3 , ' class1' , ' class2' ]); // Output ==> "3 class1 class2"
71+ cl ([null , undefined , 3 , ' class1' , ' class2' ]); // Output ==> "3 class1 class2"
8172```
8273
8374### Arguments as an object
8475
8576` Note that the key is used as the class if its value is truthy `
8677
8778``` javascript
88- classList ({ class1: true , class2 : false }); // Output ==> "class1"
79+ cl ({ class1: true , class2: false }); // Output ==> "class1"
8980
90- classList ({ class1: undefined , class2 : null , class3: true , class4: false }); // Output ==> "class3"
81+ cl ({ class1: undefined , class2: null , class3: true , class4: false }); // Output ==> "class3"
9182```
9283
9384Note that the function ** must** return a boolean.
9485
9586``` javascript
96- classList ({
97- class1 : function () { return false ; },
98- class2 : function () { return true ; }
87+ cl ({
88+ class1 : function () {
89+ return false ;
90+ },
91+ class2 : function () {
92+ return true ;
93+ },
9994});
10095
10196// Output ==> "class2"
10297```
10398
104- ### Hybrid Arguments
99+ ### Mixed Arguments Types
105100
106101``` javascript
107- classList (' class1' , ' class2' , 2 , null , undefined , [' class3' , null , undefined , 4 , ' class4' ], {
108- class5 : function () { return false ; },
109- class6 : function () { return true ; },
110- class7: undefined ,
111- class8: true ,
112- class9: false
102+ cl (' class1' , ' class2' , 2 , null , undefined , [' class3' , null , undefined , 4 , ' class4' ], {
103+ class5 : function () {
104+ return false ;
105+ },
106+ class6 : function () {
107+ return true ;
108+ },
109+ class7: undefined ,
110+ class8: true ,
111+ class9: false ,
113112});
114113
115114// Output ==> "class1 class2 2 class3 4 class4 class6 class8"
116115```
116+
117+ ## License
118+
119+ MIT © [ tusharf5] ( https://github.com/tusharf5 )
0 commit comments