Browse Source

Add Layer in docs

up-style-manager
Artur Arseniev 5 years ago
parent
commit
71e6103762
  1. 1
      docs/.vuepress/config.js
  2. 1
      docs/api.js
  3. 25
      docs/api/layer.md
  4. 4
      docs/api/property_stack.md
  5. 5
      src/style_manager/model/PropertyStack.js

1
docs/.vuepress/config.js

@ -78,6 +78,7 @@ module.exports = {
['/api/property_select', `${subDivider}PropertySelect`],
['/api/property_composite', `${subDivider}PropertyComposite`],
['/api/property_stack', `${subDivider}PropertyStack`],
['/api/layer', `${subDivider}Layer`],
['/api/storage_manager', 'Storage Manager'],
['/api/device_manager', 'Device Manager'],
['/api/device', `${subDivider}Device`],

1
docs/api.js

@ -27,6 +27,7 @@ async function generateDocs () {
['style_manager/model/PropertySelect.js', 'property_select.md'],
['style_manager/model/PropertyComposite.js', 'property_composite.md'],
['style_manager/model/PropertyStack.js', 'property_stack.md'],
['style_manager/model/Layer.js', 'layer.md'],
['storage_manager/index.js', 'storage_manager.md'],
['device_manager/index.js', 'device_manager.md'],
['device_manager/model/Device.js', 'device.md'],

25
docs/api/layer.md

@ -0,0 +1,25 @@
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## getIndex
Get layer index.
Returns **[Number][1]**
## getValues
Get layer values.
### Parameters
* `opts` **[Object][2]** Options (optional, default `{}`)
* `opts.camelCase` **[Boolean][3]?** Return property names in camelCase.
Returns **[Object][2]**
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

4
docs/api/property_stack.md

@ -4,6 +4,8 @@
**Extends PropertyComposite**
[Layer]: layer.html
### Properties
* `layerSeparator` **([String][1] | [RegExp][2])?** The separator used to split layer values.
@ -127,7 +129,7 @@ Returns **([Layer] | null)** Removed layer
### getLayerLabel
Get layer label.
Get the layer label. The label can be customized with the `layerLabel` property.
#### Parameters

5
src/style_manager/model/PropertyStack.js

@ -8,10 +8,15 @@ const VALUES_REG = /,(?![^\(]*\))/;
const PARTS_REG = /\s(?![^(]*\))/;
/**
*
* [Layer]: layer.html
*
*
* @typedef PropertyStack
* @property {String|RegExp} [layerSeparator=', '] The separator used to split layer values.
* @property {String} [layerJoin=', '] Value used to join layer values.
* @property {Function} [layerLabel] Custom logic for creating the layer value.
*
*/
export default class PropertyStack extends PropertyComposite {
defaults() {

Loading…
Cancel
Save