Browse Source

Up sector doc

up-style-manager
Artur Arseniev 4 years ago
parent
commit
31cdd01ee8
  1. 6
      docs/api/sector.md
  2. 2
      docs/api/style_manager.md
  3. 7
      src/style_manager/model/Sector.js

6
docs/api/sector.md

@ -9,7 +9,7 @@
* `id` **[String][1]** Sector id, eg. `typography`
* `name` **[String][1]** Sector name, eg. `Typography`
* `open` **[Boolean][2]?** Indicates the open state.
* `properties` **[Array][3]<[Object][4]>?** Indicate an array of Property defintions[Property]: property.html
* `properties` **[Array][3]<[Object][4]>?** Indicate an array of Property defintions.
### getId
@ -58,6 +58,10 @@ Get sector properties.
Returns **[Array][3]<[Property]>**
##
[Property]: property.html
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

2
docs/api/style_manager.md

@ -40,6 +40,8 @@ const styleManager = editor.StyleManager;
[Component]: component.html
[Property]: property.html
## getConfig
Get configuration object

7
src/style_manager/model/Sector.js

@ -8,9 +8,7 @@ import PropertyFactory from './PropertyFactory';
* @property {String} id Sector id, eg. `typography`
* @property {String} name Sector name, eg. `Typography`
* @property {Boolean} [open=true] Indicates the open state.
* @property {Array<Object>} [properties=[]] Indicate an array of Property defintions
*
* [Property]: property.html
* @property {Array<Object>} [properties=[]] Indicate an array of Property defintions.
*/
export default class Sector extends Model {
defaults() {
@ -187,3 +185,6 @@ export default class Sector extends Model {
return this.propFactory.build(buildP);
}
}
/**
* [Property]: property.html
*/

Loading…
Cancel
Save