Browse Source

Update docs

pull/3901/head
Artur Arseniev 4 years ago
parent
commit
36e3ceedfd
  1. 1
      docs/api.js
  2. 14
      docs/api/selector.md
  3. 66
      docs/api/selector_manager.md
  4. 3
      src/selector_manager/index.js

1
docs/api.js

@ -48,6 +48,7 @@ async function generateDocs () {
.replace(/\*\*\\\[/g, '**[') .replace(/\*\*\\\[/g, '**[')
.replace(/\*\*\(\\\[/g, '**([') .replace(/\*\*\(\\\[/g, '**([')
.replace(/<\\\[/g, '<[') .replace(/<\\\[/g, '<[')
.replace(/<\(\\\[/g, '<([')
.replace(/\| \\\[/g, '| [') .replace(/\| \\\[/g, '| [')
.replace('**Extends Model**', ''); .replace('**Extends Model**', '');
fs.writeFileSync(`${docRoot}/api/${file[1]}`, res); fs.writeFileSync(`${docRoot}/api/${file[1]}`, res);

14
docs/api/selector.md

@ -58,6 +58,20 @@ console.log(selector.getLabel());
// -> `New Label` // -> `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 [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

66
docs/api/selector_manager.md

@ -68,18 +68,23 @@ sm.add(...);
* [getSelected][11] * [getSelected][11]
* [addSelected][12] * [addSelected][12]
* [removeSelected][13] * [removeSelected][13]
* [setComponentFirst][14] * [getSelectedTargets][14]
* [getComponentFirst][15] * [setComponentFirst][15]
* [getComponentFirst][16]
[Selector]: selector.html [Selector]: selector.html
[State]: state.html [State]: state.html
[Component]: component.html
[CssRule]: css_rule.html
## getConfig ## getConfig
Get configuration object Get configuration object
Returns **[Object][16]** Returns **[Object][17]**
## add ## add
@ -88,8 +93,8 @@ You can pass selectors properties or string identifiers.
### Parameters ### 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`
* `opts` **[Object][16]?** Selector options (optional, default `{}`) * `opts` **[Object][17]?** Selector options (optional, default `{}`)
### Examples ### Examples
@ -109,7 +114,7 @@ Get the selector by its name/type
### Parameters ### Parameters
* `name` **[String][17]** Selector name or string identifier * `name` **[String][18]** Selector name or string identifier
* `type` * `type`
### Examples ### Examples
@ -128,7 +133,7 @@ Remove Selector.
### Parameters ### Parameters
* `selector` **([String][17] | [Selector])** Selector instance or Selector string identifier * `selector` **([String][18] | [Selector])** Selector instance or Selector string identifier
* `opts` * `opts`
### Examples ### Examples
@ -147,7 +152,7 @@ Change the selector state
### Parameters ### Parameters
* `value` **[String][17]** State value * `value` **[String][18]** State value
### Examples ### Examples
@ -161,13 +166,13 @@ Returns **this**
Get the current selector state value Get the current selector state value
Returns **[String][17]** Returns **[String][18]**
## getStates ## getStates
Get states Get states
Returns **[Array][18]<[State]>** Returns **[Array][19]<[State]>**
## setStates ## setStates
@ -175,7 +180,7 @@ Set a new collection of states
### Parameters ### Parameters
* `states` **[Array][18]<[Object][16]>** Array of new states * `states` **[Array][19]<[Object][17]>** Array of new states
* `opts` * `opts`
### Examples ### Examples
@ -187,7 +192,7 @@ const states = selectorManager.setStates([
]); ]);
``` ```
Returns **[Array][18]<[State]>** Returns **[Array][19]<[State]>**
## getSelected ## getSelected
@ -200,7 +205,7 @@ const selected = selectorManager.getSelected();
console.log(selected.map(s => s.toString())) console.log(selected.map(s => s.toString()))
``` ```
Returns **[Array][18]<[Selector]>** Returns **[Array][19]<[Selector]>**
## addSelected ## addSelected
@ -208,7 +213,7 @@ Add new selector to all selected components.
### Parameters ### 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 ### Examples
@ -222,7 +227,7 @@ Remove a common selector from all selected components.
### Parameters ### Parameters
* `selector` **([String][17] | [Selector])** Selector instance or Selector string identifier * `selector` **([String][18] | [Selector])** Selector instance or Selector string identifier
### Examples ### Examples
@ -230,6 +235,19 @@ Remove a common selector from all selected components.
selectorManager.removeSelected('.myclass'); 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 ## setComponentFirst
Update component-first option. Update component-first option.
@ -238,13 +256,13 @@ of selectors (which would change styles on all components with those classes).
### Parameters ### Parameters
* `value` **[Boolean][19]** * `value` **[Boolean][20]**
## getComponentFirst ## getComponentFirst
Get the value of component-first option. Get the value of component-first option.
Returns **[Boolean][19]** Returns **[Boolean][20]**
## getAll ## getAll
@ -278,14 +296,16 @@ Returns **Collection<[Selector]>**
[13]: #removeselected [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

3
src/selector_manager/index.js

@ -60,11 +60,14 @@
* * [getSelected](#getselected) * * [getSelected](#getselected)
* * [addSelected](#addselected) * * [addSelected](#addselected)
* * [removeSelected](#removeselected) * * [removeSelected](#removeselected)
* * [getSelectedTargets](#getselectedtargets)
* * [setComponentFirst](#setcomponentfirst) * * [setComponentFirst](#setcomponentfirst)
* * [getComponentFirst](#getcomponentfirst) * * [getComponentFirst](#getcomponentfirst)
* *
* [Selector]: selector.html * [Selector]: selector.html
* [State]: state.html * [State]: state.html
* [Component]: component.html
* [CssRule]: css_rule.html
* *
* @module SelectorManager * @module SelectorManager
*/ */

Loading…
Cancel
Save