Browse Source

Update docs

pull/4849/head
Artur Arseniev 3 years ago
parent
commit
c2100a6ace
  1. 16
      docs/api.js
  2. 2
      docs/api/commands.md
  3. 2
      docs/api/css_composer.md
  4. 2
      docs/api/modal_dialog.md
  5. 20
      docs/api/property_stack.md
  6. 3
      src/style_manager/model/Sector.ts

16
docs/api.js

@ -20,14 +20,14 @@ async function generateDocs () {
['dom_components/index.ts', 'components.md'],
['dom_components/model/Component.js', 'component.md'],
['panels/index.ts', 'panels.md'],
['style_manager/index.js', 'style_manager.md'],
['style_manager/model/Sector.js', 'sector.md'],
['style_manager/model/Property.js', 'property.md'],
['style_manager/model/PropertyNumber.js', 'property_number.md'],
['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'],
// ['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'],
['style_manager/model/PropertySelect.ts', 'property_select.md'],
['style_manager/model/PropertyComposite.ts', 'property_composite.md'],
['style_manager/model/PropertyStack.ts', 'property_stack.md'],
['style_manager/model/Layer.ts', 'layer.md'],
['storage_manager/index.ts', 'storage_manager.md'],
['device_manager/index.ts', 'device_manager.md'],
['device_manager/model/Device.ts', 'device.md'],

2
docs/api/commands.md

@ -95,7 +95,7 @@ Extend the command. The command to extend should be defined as an object
### Parameters
* `id` **[string][11]** Command's ID
* `cmd` **CustomCommand** (optional, default `{}`)
* `cmd` **CommandObject** (optional, default `{}`)
* `Object` **[Object][12]** with the new command functions
### Examples

2
docs/api/css_composer.md

@ -53,7 +53,7 @@ Add/update the CssRule.
### Parameters
* `selectors` **[String][8]** Selector string, eg. `.myclass`
* `style` **[Object][10]** Style properties and values
* `style` **[Object][10]** Style properties and values (optional, default `{}`)
* `opts` **[Object][10]** Additional properties (optional, default `{}`)
* `opts.atRuleType` **[String][8]** At-rule type, eg. `media` (optional, default `''`)

2
docs/api/modal_dialog.md

@ -188,7 +188,7 @@ modal.getContent();
Returns **([string][12] | [HTMLElement][13])**
[1]: https://github.com/artf/grapesjs/blob/master/src/modal_dialog/config/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/modal_dialog/config/config.ts
[2]: #open

20
docs/api/property_stack.md

@ -49,7 +49,7 @@ Returns **([Layer] | null)**
Get selected layer.
Returns **([Layer] | null)**
Returns **([Layer] | [undefined][7])**
### selectLayer
@ -103,8 +103,8 @@ Add new layer to the stack.
#### Parameters
* `props` **[Object][7]** Custom property values to use in a new layer. (optional, default `{}`)
* `opts` **[Object][7]** Options (optional, default `{}`)
* `props` **[Object][8]** Custom property values to use in a new layer. (optional, default `{}`)
* `opts` **[Object][8]** Options (optional, default `{}`)
* `opts.at` **[Number][6]?** Position index (by default the layer will be appended at the end).
@ -174,12 +174,12 @@ Get style object from the layer.
#### Parameters
* `layer` **[Layer]**
* `opts` **[Object][7]** Options (optional, default `{}`)
* `opts` **[Object][8]** Options (optional, default `{}`)
* `opts.camelCase` **[Boolean][1]?** Return property names in camelCase.
* `opts.number` **[Object][7]?** Limit the result of the number types, eg. `number: { min: -3, max: 3 }`
* `opts.number` **[Object][8]?** Limit the result of the number types, eg. `number: { min: -3, max: 3 }`
Returns **[Object][7]** Style object
Returns **[Object][8]** Style object
### getStylePreview
@ -189,9 +189,9 @@ If the property has `preview: false` the returned object will be empty.
#### Parameters
* `layer` **[Layer]**
* `opts` **[Object][7]** Options. Same of `getStyleFromLayer` (optional, default `{}`)
* `opts` **[Object][8]** Options. Same of `getStyleFromLayer` (optional, default `{}`)
Returns **[Object][7]** Style object
Returns **[Object][8]** Style object
### getLayerSeparator
@ -211,4 +211,6 @@ Returns **[RegExp][3]**
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

3
src/style_manager/model/Sector.ts

@ -39,6 +39,9 @@ export default class Sector extends Model<SectorProperties> {
};
}
/**
* @hideconstructor
*/
constructor(prp: SectorProperties, opts: { em?: EditorModel } = {}) {
super(prp);
const { em } = opts;

Loading…
Cancel
Save