|
|
|
@ -60,17 +60,18 @@ sm.add(...); |
|
|
|
* [add][3] |
|
|
|
* [get][4] |
|
|
|
* [remove][5] |
|
|
|
* [getAll][6] |
|
|
|
* [setState][7] |
|
|
|
* [getState][8] |
|
|
|
* [getStates][9] |
|
|
|
* [setStates][10] |
|
|
|
* [getSelected][11] |
|
|
|
* [addSelected][12] |
|
|
|
* [removeSelected][13] |
|
|
|
* [getSelectedTargets][14] |
|
|
|
* [setComponentFirst][15] |
|
|
|
* [getComponentFirst][16] |
|
|
|
* [rename][6] |
|
|
|
* [getAll][7] |
|
|
|
* [setState][8] |
|
|
|
* [getState][9] |
|
|
|
* [getStates][10] |
|
|
|
* [setStates][11] |
|
|
|
* [getSelected][12] |
|
|
|
* [addSelected][13] |
|
|
|
* [removeSelected][14] |
|
|
|
* [getSelectedTargets][15] |
|
|
|
* [setComponentFirst][16] |
|
|
|
* [getComponentFirst][17] |
|
|
|
|
|
|
|
[Selector]: selector.html |
|
|
|
|
|
|
|
@ -84,7 +85,7 @@ sm.add(...); |
|
|
|
|
|
|
|
Get configuration object |
|
|
|
|
|
|
|
Returns **[Object][17]** |
|
|
|
Returns **[Object][18]** |
|
|
|
|
|
|
|
## add |
|
|
|
|
|
|
|
@ -93,8 +94,8 @@ You can pass selectors properties or string identifiers. |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `props` **([Object][17] | [String][18])** Selector properties or string identifiers, eg. `{ name: 'my-class', label: 'My class' }`, `.my-cls` |
|
|
|
* `opts` **[Object][17]?** Selector options (optional, default `{}`) |
|
|
|
* `props` **([Object][18] | [String][19])** Selector properties or string identifiers, eg. `{ name: 'my-class', label: 'My class' }`, `.my-cls` |
|
|
|
* `opts` **[Object][18]?** Selector options (optional, default `{}`) |
|
|
|
|
|
|
|
### Examples |
|
|
|
|
|
|
|
@ -114,8 +115,8 @@ Get the selector by its name/type |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `name` **[String][18]** Selector name or string identifier |
|
|
|
* `type` **[number][19]?** |
|
|
|
* `name` **[String][19]** Selector name or string identifier |
|
|
|
* `type` **[number][20]?** |
|
|
|
|
|
|
|
### Examples |
|
|
|
|
|
|
|
@ -133,7 +134,7 @@ Remove Selector. |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `selector` **([String][18] | [Selector])** Selector instance or Selector string identifier |
|
|
|
* `selector` **([String][19] | [Selector])** Selector instance or Selector string identifier |
|
|
|
* `opts` **RemoveOptions?** |
|
|
|
|
|
|
|
### Examples |
|
|
|
@ -146,13 +147,33 @@ selectorManager.remove(selectorManager.get('.myclass')); |
|
|
|
|
|
|
|
Returns **[Selector]** Removed Selector |
|
|
|
|
|
|
|
## rename |
|
|
|
|
|
|
|
Rename Selector. |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `selector` **[Selector]** Selector to update. |
|
|
|
* `name` **[String][19]** New name for the selector. |
|
|
|
* `opts` **SetOptions?** |
|
|
|
|
|
|
|
### Examples |
|
|
|
|
|
|
|
```javascript |
|
|
|
const selector = selectorManager.get('myclass'); |
|
|
|
const result = selectorManager.rename(selector, 'myclass2'); |
|
|
|
console.log(result === selector ? 'Selector updated' : 'Selector with this name exists already'); |
|
|
|
``` |
|
|
|
|
|
|
|
Returns **[Selector]** Selector containing the passed name. |
|
|
|
|
|
|
|
## setState |
|
|
|
|
|
|
|
Change the selector state |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `value` **[String][18]** State value |
|
|
|
* `value` **[String][19]** State value |
|
|
|
|
|
|
|
### Examples |
|
|
|
|
|
|
|
@ -166,13 +187,13 @@ Returns **this** |
|
|
|
|
|
|
|
Get the current selector state value |
|
|
|
|
|
|
|
Returns **[String][18]** |
|
|
|
Returns **[String][19]** |
|
|
|
|
|
|
|
## getStates |
|
|
|
|
|
|
|
Get states |
|
|
|
|
|
|
|
Returns **[Array][20]<[State]>** |
|
|
|
Returns **[Array][21]<[State]>** |
|
|
|
|
|
|
|
## setStates |
|
|
|
|
|
|
|
@ -180,7 +201,7 @@ Set a new collection of states |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `states` **[Array][20]<[Object][17]>** Array of new states |
|
|
|
* `states` **[Array][21]<[Object][18]>** Array of new states |
|
|
|
* `opts` **any?** |
|
|
|
|
|
|
|
### Examples |
|
|
|
@ -192,7 +213,7 @@ const states = selectorManager.setStates([ |
|
|
|
]); |
|
|
|
``` |
|
|
|
|
|
|
|
Returns **[Array][20]<[State]>** |
|
|
|
Returns **[Array][21]<[State]>** |
|
|
|
|
|
|
|
## getSelected |
|
|
|
|
|
|
|
@ -205,7 +226,7 @@ const selected = selectorManager.getSelected(); |
|
|
|
console.log(selected.map(s => s.toString())) |
|
|
|
``` |
|
|
|
|
|
|
|
Returns **[Array][20]<[Selector]>** |
|
|
|
Returns **[Array][21]<[Selector]>** |
|
|
|
|
|
|
|
## getSelectedAll |
|
|
|
|
|
|
|
@ -218,7 +239,7 @@ const selected = selectorManager.getSelectedAll(); |
|
|
|
console.log(selected.map(s => s.toString())) |
|
|
|
``` |
|
|
|
|
|
|
|
Returns **[Array][20]<[Selector]>** |
|
|
|
Returns **[Array][21]<[Selector]>** |
|
|
|
|
|
|
|
## addSelected |
|
|
|
|
|
|
|
@ -226,7 +247,7 @@ Add new selector to all selected components. |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `props` **([Object][17] | [String][18])** Selector properties or string identifiers, eg. `{ name: 'my-class', label: 'My class' }`, `.my-cls` |
|
|
|
* `props` **([Object][18] | [String][19])** Selector properties or string identifiers, eg. `{ name: 'my-class', label: 'My class' }`, `.my-cls` |
|
|
|
|
|
|
|
### Examples |
|
|
|
|
|
|
|
@ -240,7 +261,7 @@ Remove a common selector from all selected components. |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `selector` **([String][18] | [Selector])** Selector instance or Selector string identifier |
|
|
|
* `selector` **([String][19] | [Selector])** Selector instance or Selector string identifier |
|
|
|
|
|
|
|
### Examples |
|
|
|
|
|
|
|
@ -259,7 +280,7 @@ const targetsToStyle = selectorManager.getSelectedTargets(); |
|
|
|
console.log(targetsToStyle.map(target => target.getSelectorsString())) |
|
|
|
``` |
|
|
|
|
|
|
|
Returns **[Array][20]<([Component] | [CssRule])>** |
|
|
|
Returns **[Array][21]<([Component] | [CssRule])>** |
|
|
|
|
|
|
|
## setComponentFirst |
|
|
|
|
|
|
|
@ -269,13 +290,13 @@ of selectors (which would change styles on all components with those classes). |
|
|
|
|
|
|
|
### Parameters |
|
|
|
|
|
|
|
* `value` **[Boolean][21]** |
|
|
|
* `value` **[Boolean][22]** |
|
|
|
|
|
|
|
## getComponentFirst |
|
|
|
|
|
|
|
Get the value of component-first option. |
|
|
|
|
|
|
|
Returns **[Boolean][21]** |
|
|
|
Returns **[Boolean][22]** |
|
|
|
|
|
|
|
## getAll |
|
|
|
|
|
|
|
@ -293,34 +314,36 @@ Returns **Collection<[Selector]>** |
|
|
|
|
|
|
|
[5]: #remove |
|
|
|
|
|
|
|
[6]: #getall |
|
|
|
[6]: #rename |
|
|
|
|
|
|
|
[7]: #getall |
|
|
|
|
|
|
|
[7]: #setstate |
|
|
|
[8]: #setstate |
|
|
|
|
|
|
|
[8]: #getstate |
|
|
|
[9]: #getstate |
|
|
|
|
|
|
|
[9]: #getstates |
|
|
|
[10]: #getstates |
|
|
|
|
|
|
|
[10]: #setstates |
|
|
|
[11]: #setstates |
|
|
|
|
|
|
|
[11]: #getselected |
|
|
|
[12]: #getselected |
|
|
|
|
|
|
|
[12]: #addselected |
|
|
|
[13]: #addselected |
|
|
|
|
|
|
|
[13]: #removeselected |
|
|
|
[14]: #removeselected |
|
|
|
|
|
|
|
[14]: #getselectedtargets |
|
|
|
[15]: #getselectedtargets |
|
|
|
|
|
|
|
[15]: #setcomponentfirst |
|
|
|
[16]: #setcomponentfirst |
|
|
|
|
|
|
|
[16]: #getcomponentfirst |
|
|
|
[17]: #getcomponentfirst |
|
|
|
|
|
|
|
[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object |
|
|
|
[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object |
|
|
|
|
|
|
|
[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String |
|
|
|
[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String |
|
|
|
|
|
|
|
[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number |
|
|
|
[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number |
|
|
|
|
|
|
|
[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array |
|
|
|
[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array |
|
|
|
|
|
|
|
[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean |
|
|
|
[22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean |
|
|
|
|