From 36e3ceedfd8a18368cb9f3fa3d9fa8970bcdb431 Mon Sep 17 00:00:00 2001 From: Artur Arseniev Date: Wed, 27 Oct 2021 16:29:47 +0200 Subject: [PATCH] Update docs --- docs/api.js | 1 + docs/api/selector.md | 14 ++++++++ docs/api/selector_manager.md | 66 +++++++++++++++++++++++------------ src/selector_manager/index.js | 3 ++ 4 files changed, 61 insertions(+), 23 deletions(-) diff --git a/docs/api.js b/docs/api.js index a6a49818c..988498f4b 100644 --- a/docs/api.js +++ b/docs/api.js @@ -48,6 +48,7 @@ async function generateDocs () { .replace(/\*\*\\\[/g, '**[') .replace(/\*\*\(\\\[/g, '**([') .replace(/<\\\[/g, '<[') + .replace(/<\(\\\[/g, '<([') .replace(/\| \\\[/g, '| [') .replace('**Extends Model**', ''); fs.writeFileSync(`${docRoot}/api/${file[1]}`, res); diff --git a/docs/api/selector.md b/docs/api/selector.md index 86c844b30..a4dc299e6 100644 --- a/docs/api/selector.md +++ b/docs/api/selector.md @@ -58,6 +58,20 @@ console.log(selector.getLabel()); // -> `New Label` ``` +### getActive + +Get selector active state. + +Returns **[Boolean][3]** + +### setActive + +Update selector active state. + +#### Parameters + +* `value` **[Boolean][3]** New active state + [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number diff --git a/docs/api/selector_manager.md b/docs/api/selector_manager.md index e9937e243..ddddca450 100644 --- a/docs/api/selector_manager.md +++ b/docs/api/selector_manager.md @@ -68,18 +68,23 @@ sm.add(...); * [getSelected][11] * [addSelected][12] * [removeSelected][13] -* [setComponentFirst][14] -* [getComponentFirst][15] +* [getSelectedTargets][14] +* [setComponentFirst][15] +* [getComponentFirst][16] [Selector]: selector.html [State]: state.html +[Component]: component.html + +[CssRule]: css_rule.html + ## getConfig Get configuration object -Returns **[Object][16]** +Returns **[Object][17]** ## add @@ -88,8 +93,8 @@ You can pass selectors properties or string identifiers. ### Parameters -* `props` **([Object][16] | [String][17])** Selector properties or string identifiers, eg. `{ name: 'my-class', label: 'My class' }`, `.my-cls` -* `opts` **[Object][16]?** Selector options (optional, default `{}`) +* `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 `{}`) ### Examples @@ -109,7 +114,7 @@ Get the selector by its name/type ### Parameters -* `name` **[String][17]** Selector name or string identifier +* `name` **[String][18]** Selector name or string identifier * `type` ### Examples @@ -128,7 +133,7 @@ Remove Selector. ### Parameters -* `selector` **([String][17] | [Selector])** Selector instance or Selector string identifier +* `selector` **([String][18] | [Selector])** Selector instance or Selector string identifier * `opts` ### Examples @@ -147,7 +152,7 @@ Change the selector state ### Parameters -* `value` **[String][17]** State value +* `value` **[String][18]** State value ### Examples @@ -161,13 +166,13 @@ Returns **this** Get the current selector state value -Returns **[String][17]** +Returns **[String][18]** ## getStates Get states -Returns **[Array][18]<[State]>** +Returns **[Array][19]<[State]>** ## setStates @@ -175,7 +180,7 @@ Set a new collection of states ### Parameters -* `states` **[Array][18]<[Object][16]>** Array of new states +* `states` **[Array][19]<[Object][17]>** Array of new states * `opts` ### Examples @@ -187,7 +192,7 @@ const states = selectorManager.setStates([ ]); ``` -Returns **[Array][18]<[State]>** +Returns **[Array][19]<[State]>** ## getSelected @@ -200,7 +205,7 @@ const selected = selectorManager.getSelected(); console.log(selected.map(s => s.toString())) ``` -Returns **[Array][18]<[Selector]>** +Returns **[Array][19]<[Selector]>** ## addSelected @@ -208,7 +213,7 @@ Add new selector to all selected components. ### Parameters -* `props` **([Object][16] | [String][17])** Selector properties or string identifiers, eg. `{ name: 'my-class', label: 'My class' }`, `.my-cls` +* `props` **([Object][17] | [String][18])** Selector properties or string identifiers, eg. `{ name: 'my-class', label: 'My class' }`, `.my-cls` ### Examples @@ -222,7 +227,7 @@ Remove a common selector from all selected components. ### Parameters -* `selector` **([String][17] | [Selector])** Selector instance or Selector string identifier +* `selector` **([String][18] | [Selector])** Selector instance or Selector string identifier ### Examples @@ -230,6 +235,19 @@ Remove a common selector from all selected components. selectorManager.removeSelected('.myclass'); ``` +## getSelectedTargets + +Get the array of currently selected targets. + +### Examples + +```javascript +const targetsToStyle = selectorManager.getSelectedTargets(); +console.log(targetsToStyle.map(target => target.getSelectorsString())) +``` + +Returns **[Array][19]<([Component] | [CssRule])>** + ## setComponentFirst Update component-first option. @@ -238,13 +256,13 @@ of selectors (which would change styles on all components with those classes). ### Parameters -* `value` **[Boolean][19]** +* `value` **[Boolean][20]** ## getComponentFirst Get the value of component-first option. -Returns **[Boolean][19]** +Returns **[Boolean][20]** ## getAll @@ -278,14 +296,16 @@ Returns **Collection<[Selector]>** [13]: #removeselected -[14]: #setcomponentfirst +[14]: #getselectedtargets + +[15]: #setcomponentfirst -[15]: #getcomponentfirst +[16]: #getcomponentfirst -[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/src/selector_manager/index.js b/src/selector_manager/index.js index 2de35a9a7..221c5c6ab 100644 --- a/src/selector_manager/index.js +++ b/src/selector_manager/index.js @@ -60,11 +60,14 @@ * * [getSelected](#getselected) * * [addSelected](#addselected) * * [removeSelected](#removeselected) + * * [getSelectedTargets](#getselectedtargets) * * [setComponentFirst](#setcomponentfirst) * * [getComponentFirst](#getcomponentfirst) * * [Selector]: selector.html * [State]: state.html + * [Component]: component.html + * [CssRule]: css_rule.html * * @module SelectorManager */