Browse Source

Up for api docs

pull/4695/head
Artur Arseniev 3 years ago
parent
commit
01352d366d
  1. 4
      docs/api.js
  2. 2
      docs/api/block_manager.md
  3. 2
      docs/api/canvas.md
  4. 4
      docs/api/css_composer.md
  5. 5
      docs/api/css_rule.md
  6. 2
      docs/api/device_manager.md
  7. 2
      docs/api/i18n.md
  8. 2
      docs/api/selector_manager.md

4
docs/api.js

@ -34,8 +34,8 @@ async function generateDocs () {
['selector_manager/index.ts', 'selector_manager.md'],
['selector_manager/model/Selector.ts', 'selector.md'],
['selector_manager/model/State.ts', 'state.md'],
['css_composer/index.js', 'css_composer.md'],
['css_composer/model/CssRule.js', 'css_rule.md'],
['css_composer/index.ts', 'css_composer.md'],
['css_composer/model/CssRule.ts', 'css_rule.md'],
['modal_dialog/index.ts', 'modal_dialog.md'],
['rich_text_editor/index.js', 'rich_text_editor.md'],
['keymaps/index.js', 'keymaps.md'],

2
docs/api/block_manager.md

@ -189,7 +189,7 @@ document.getElementById('some-id').appendChild(newBlocksEl);
Returns **[HTMLElement][14]** Rendered element
[1]: https://github.com/artf/grapesjs/blob/master/src/block_manager/config/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/block_manager/config/config.ts
[2]: #add

2
docs/api/canvas.md

@ -233,7 +233,7 @@ canvas.addFrame({
Returns **[Frame]**
[1]: https://github.com/artf/grapesjs/blob/master/src/canvas/config/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/canvas/config/config.ts
[2]: #getconfig

4
docs/api/css_composer.md

@ -131,7 +131,7 @@ Remove rule, by CssRule or matching selector (eg. the selector will match also a
### Parameters
* `rule` **([String][8] | [CssRule] | [Array][9]<[CssRule]>)** CssRule or matching selector.
* `opts`
* `opts` **any?**
### Examples
@ -155,7 +155,7 @@ Remove all rules
Returns **this**
[1]: https://github.com/artf/grapesjs/blob/master/src/css_composer/config/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/css_composer/config/config.ts
[2]: #addrules

5
docs/api/css_rule.md

@ -4,6 +4,11 @@
**Extends StyleableModel**
### Parameters
* `props` **CssRuleProperties**
* `opt` **any** (optional, default `{}`)
### Properties
* `selectors` **[Array][1]\<Selector>** Array of selectors

2
docs/api/device_manager.md

@ -148,7 +148,7 @@ const selected = deviceManager.getSelected();
Returns **[Device]**
[1]: https://github.com/artf/grapesjs/blob/master/src/device_manager/config/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/device_manager/config/config.ts
[2]: #add

2
docs/api/i18n.md

@ -150,7 +150,7 @@ obj.t('msg2', { l: 'it', params: { test: 'hello' } }); // custom local
Returns **[String][3]**
[1]: https://github.com/artf/grapesjs/blob/master/src/i18n/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/i18n/config.ts
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

2
docs/api/selector_manager.md

@ -270,7 +270,7 @@ Get all selectors
Returns **Collection<[Selector]>**
[1]: https://github.com/artf/grapesjs/blob/master/src/selector_manager/config/config.js
[1]: https://github.com/artf/grapesjs/blob/master/src/selector_manager/config/config.ts
[2]: #getconfig

Loading…
Cancel
Save