From 001f927788292e5fbe7914c6ace88daad6da5fe0 Mon Sep 17 00:00:00 2001 From: Artur Arseniev Date: Sun, 22 Jan 2023 12:31:15 +0400 Subject: [PATCH] Update docs --- docs/api.js | 2 +- docs/api/component.md | 24 +++++++++++++----------- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/api.js b/docs/api.js index 247749c59..6fbbf2181 100644 --- a/docs/api.js +++ b/docs/api.js @@ -18,7 +18,7 @@ async function generateDocs () { ['block_manager/model/Block.ts', 'block.md'], ['commands/index.ts', 'commands.md'], ['dom_components/index.ts', 'components.md'], - ['dom_components/model/Component.js', 'component.md'], + ['dom_components/model/Component.ts', 'component.md'], ['panels/index.ts', 'panels.md'], ['style_manager/index.ts', 'style_manager.md'], ['style_manager/model/Sector.ts', 'sector.md'], diff --git a/docs/api/component.md b/docs/api/component.md index 4290ae3a6..46cf1c10f 100644 --- a/docs/api/component.md +++ b/docs/api/component.md @@ -230,7 +230,7 @@ Update attributes of the component ### Parameters * `attrs` **[Object][2]** Key value attributes -* `opts` (optional, default `{}`) +* `opts` **SetOptions** (optional, default `{}`) * `options` **[Object][2]** Options for the model update ### Examples @@ -248,7 +248,7 @@ Add attributes to the component ### Parameters * `attrs` **[Object][2]** Key value attributes -* `opts` (optional, default `{}`) +* `opts` **SetOptions** (optional, default `{}`) * `options` **[Object][2]** Options for the model update ### Examples @@ -266,7 +266,7 @@ Remove attributes from the component ### Parameters * `attrs` **([String][1] | [Array][5]<[String][1]>)** Array of attributes to remove (optional, default `[]`) -* `opts` (optional, default `{}`) +* `opts` **SetOptions** (optional, default `{}`) * `options` **[Object][2]** Options for the model update ### Examples @@ -284,8 +284,8 @@ Get the style of the component ### Parameters -* `options` (optional, default `{}`) -* `optsAdd` (optional, default `{}`) +* `options` **any** (optional, default `{}`) +* `optsAdd` **any** (optional, default `{}`) Returns **[Object][2]** @@ -296,7 +296,7 @@ Set the style on the component ### Parameters * `prop` **[Object][2]** Key value style object (optional, default `{}`) -* `opts` (optional, default `{}`) +* `opts` **any** (optional, default `{}`) ### Examples @@ -312,7 +312,7 @@ Return all component's attributes ### Parameters -* `opts` (optional, default `{}`) +* `opts` **{noClass: [boolean][3]?, noStyle: [boolean][3]?}** (optional, default `{}`) Returns **[Object][2]** @@ -474,7 +474,7 @@ Get the parent component, if exists ### Parameters -* `opts` (optional, default `{}`) +* `opts` **any** (optional, default `{}`) ### Examples @@ -685,7 +685,9 @@ Return an object containing only changed props ### Parameters -* `res` +* `res` **Partial\** + +Returns **Partial\** ## getId @@ -700,7 +702,7 @@ Set new id on the component ### Parameters * `id` **[String][1]** -* `opts` +* `opts` **any?** Returns **this** @@ -750,7 +752,7 @@ Remove the component ### Parameters -* `opts` (optional, default `{}`) +* `opts` **any** (optional, default `{}`) Returns **this**