Browse Source

Up docs

pull/4849/head
Artur Arseniev 3 years ago
parent
commit
0e6455e1eb
  1. 2
      docs/api.js
  2. 12
      docs/api/style_manager.md
  3. 2
      src/style_manager/index.ts

2
docs/api.js

@ -20,7 +20,7 @@ async function generateDocs () {
['dom_components/index.ts', 'components.md'],
['dom_components/model/Component.js', 'component.md'],
['panels/index.ts', 'panels.md'],
// ['style_manager/index.ts', 'style_manager.md'],
['style_manager/index.ts', 'style_manager.md'],
['style_manager/model/Sector.ts', 'sector.md'],
['style_manager/model/Property.ts', 'property.md'],
['style_manager/model/PropertyNumber.ts', 'property_number.md'],

12
docs/api/style_manager.md

@ -109,7 +109,7 @@ Get sector by id.
### Parameters
* `id` **[String][23]** Sector id
* `opts` (optional, default `{}`)
* `opts` **{warn: [boolean][26]?}** (optional, default `{}`)
### Examples
@ -197,7 +197,7 @@ Get the property.
const property = styleManager.getProperty('mySector', 'min-height');
```
Returns **([Property] | null)**
Returns **([Property] | [undefined][29])**
## getProperties
@ -213,7 +213,7 @@ Get all properties of the sector.
const properties = styleManager.getProperties('mySector');
```
Returns **(Collection<[Property]> | null)** Collection of properties
Returns **(Collection<[Property]> | [undefined][29])** Collection of properties
## removeProperty
@ -240,7 +240,7 @@ The target could be a Component, CSSRule, or a CSS selector string.
### Parameters
* `target` **([Component] | [CSSRule] | [String][23])**
* `opts` (optional, default `{}`)
* `opts` **{stylable: [boolean][26]?, component: Component?}** (optional, default `{}`)
### Examples
@ -386,7 +386,7 @@ Get all types
Returns **[Array][27]**
[1]: https://github.com/artf/grapesjs/blob/master/src/style_manager/config/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/style_manager/config/config.ts
[2]: #getconfig
@ -441,3 +441,5 @@ Returns **[Array][27]**
[27]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[28]: property.html#properties
[29]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined

2
src/style_manager/index.ts

@ -60,7 +60,7 @@
* [Component]: component.html
* [Property]: property.html
*
* @module StyleManager
* @module docsjs.StyleManager
*/
import { isUndefined, isArray, isString, debounce, bindAll } from 'underscore';

Loading…
Cancel
Save