From 01352d366dbbd846e8dd0d29249062814cf79384 Mon Sep 17 00:00:00 2001 From: Artur Arseniev Date: Tue, 25 Oct 2022 17:05:50 +0400 Subject: [PATCH] Up for api docs --- docs/api.js | 4 ++-- docs/api/block_manager.md | 2 +- docs/api/canvas.md | 2 +- docs/api/css_composer.md | 4 ++-- docs/api/css_rule.md | 5 +++++ docs/api/device_manager.md | 2 +- docs/api/i18n.md | 2 +- docs/api/selector_manager.md | 2 +- 8 files changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/api.js b/docs/api.js index 3f5ad1f2a..28daba1a2 100644 --- a/docs/api.js +++ b/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'], diff --git a/docs/api/block_manager.md b/docs/api/block_manager.md index 48fbc81ea..c74a8c854 100644 --- a/docs/api/block_manager.md +++ b/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 diff --git a/docs/api/canvas.md b/docs/api/canvas.md index 794dd111b..5c9c2a831 100644 --- a/docs/api/canvas.md +++ b/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 diff --git a/docs/api/css_composer.md b/docs/api/css_composer.md index 2482af354..6e90e31f7 100644 --- a/docs/api/css_composer.md +++ b/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 diff --git a/docs/api/css_rule.md b/docs/api/css_rule.md index 2f293d5fd..40f3d77f9 100644 --- a/docs/api/css_rule.md +++ b/docs/api/css_rule.md @@ -4,6 +4,11 @@ **Extends StyleableModel** +### Parameters + +* `props` **CssRuleProperties** +* `opt` **any** (optional, default `{}`) + ### Properties * `selectors` **[Array][1]\** Array of selectors diff --git a/docs/api/device_manager.md b/docs/api/device_manager.md index 46d619ce9..0d2b862f9 100644 --- a/docs/api/device_manager.md +++ b/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 diff --git a/docs/api/i18n.md b/docs/api/i18n.md index 691bf9ebe..3aa21acd5 100644 --- a/docs/api/i18n.md +++ b/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 diff --git a/docs/api/selector_manager.md b/docs/api/selector_manager.md index dc39edb2b..4526b0a7c 100644 --- a/docs/api/selector_manager.md +++ b/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