Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[update] indents #6

Merged
merged 2 commits into from
May 26, 2024
Merged

[update] indents #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d06e82
[update] indents
serhiipylypchuk1991 May 24, 2024
2f69523
[update] Add checker on broken links
serhiipylypchuk1991 May 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions docs/sidebar/api/api_customhtml_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,46 +10,46 @@ description: You can explore the Sidebar custom HTML properties of Sidebar in th

~~~js
const data = [
{
type: "customHTML",
id?: string | number,
parent?: string,
html?: string,
css?: string | string[],
hidden?: boolean,
{
type: "customHTML",
id?: string | number,
parent?: string,
html?: string,
css?: string | string[],
hidden?: boolean,
},
// more Sidebar controls
// more Sidebar controls
]
~~~

### Description

<table>
<tbody>
<tbody>
<tr>
<td><b>type</b></td>
<td>(required) the item type, set it to "customHTML". If not specified - the <a href="../../navitem">"navItem"</a> type is applied by default.</td>
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of an item, auto-generated if not set</td>
</tr>
<tr>
<td><b>parent</b></td>
<td>(optional) the parent of the item</td>
</tr>
<tr>
<td><b>html</b></td>
<td>(optional) a string with HTML that should be inserted into the item</td>
</tr>
<tr>
<td><b>css</b></td>
<td>(optional) adds style classes</td>
</tr>
<tr>
<td><b>hidden</b></td>
<td>(optional) defines whether an item is hidden</td>
</tr>
<td><b>type</b></td>
<td>(required) the item type, set it to "customHTML". If not specified - the <a href="../../navitem">"navItem"</a> type is applied by default.</td>
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of an item, auto-generated if not set</td>
</tr>
<tr>
<td><b>parent</b></td>
<td>(optional) the parent of the item</td>
</tr>
<tr>
<td><b>html</b></td>
<td>(optional) a string with HTML that should be inserted into the item</td>
</tr>
<tr>
<td><b>css</b></td>
<td>(optional) adds style classes</td>
</tr>
<tr>
<td><b>hidden</b></td>
<td>(optional) defines whether an item is hidden</td>
</tr>
</tbody>
</table>

Expand Down
140 changes: 70 additions & 70 deletions docs/sidebar/api/api_menuitem_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,88 +10,88 @@ description: You can explore the Sidebar MenuItem properties of Sidebar in the d

~~~js
const data = [
{
type: "menuItem",
id?: string | number,
parent?: string,
value?: string,
items?: IMenuElement[], // ISpacer | ISeparator | IMenuItem
count?: number,
countColor?: "danger" | "secondary" | "primary" | "success",
hotkey?: string,
html?: string,
icon?: string,
tooltip?: string,
{
type: "menuItem",
id?: string | number,
parent?: string,
value?: string,
items?: IMenuElement[], // ISpacer | ISeparator | IMenuItem
count?: number,
countColor?: "danger" | "secondary" | "primary" | "success",
hotkey?: string,
html?: string,
icon?: string,
tooltip?: string,

css?: string | string[],
disabled?: boolean,
hidden?: boolean,
css?: string | string[],
disabled?: boolean,
hidden?: boolean,
},
// more Sidebar controls
// more Sidebar controls
]
~~~

### Description

<table>
<tbody>
<tbody>
<tr>
<td><b>type</b></td>
<td>(required) the type of a control, set it to "menuItem". If not specified - the <a href="../../navitem">"navItem"</a> type is applied by default.</td>
</tr>
<td><b>type</b></td>
<td>(required) the type of a control, set it to "menuItem". If not specified - the <a href="../../navitem">"navItem"</a> type is applied by default.</td>
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
</tr>
<tr>
<td><b>parent</b></td>
<td>(optional) the parent of the item</td>
</tr>
<tr>
<td><b>value</b></td>
<td>(optional) a value for the menu item. You need to set either the <b>value</b> or <b>html</b> property to the item</td>
</tr>
<tr>
<td><b>items</b></td>
<td>(optional) an array of children controls (note that all the children should have the type <i>menuItem</i>)</td>
</tr>
<tr>
<td><b>count</b></td>
<td>(optional) a badge with a number</td>
</tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
</tr>
<tr>
<td><b>countColor</b></td>
<td>(optional) the color of a badge with number: "danger" | "secondary" | "primary" | "success" </td>
</tr>
<tr>
<td><b>hotkey</b></td>
<td>(optional) the name of a keyboard shortcut for a menu item</td>
</tr>
<tr>
<td><b>html</b></td>
<td>(optional) a string with HTML that should be inserted into the menu item</td>
</tr>
<td><b>parent</b></td>
<td>(optional) the parent of the item</td>
</tr>
<tr>
<td><b>icon</b></td>
<td>(optional) the name of an <a href="../../../menu/customization">icon</a> from the used icon font</td>
</tr>
<tr>
<td><b>tooltip</b></td>
<td>(optional) a tooltip for the menuItem</td>
</tr>
<tr>
<td><b>css</b></td>
<td>(optional) adds style classes</td>
</tr>
<tr>
<td><b>disabled</b></td>
<td>(optional) defines whether an item is disabled</td>
</tr>
<tr>
<td><b>hidden</b></td>
<td>(optional) defines whether a control is hidden</td>
</tr>
<td><b>value</b></td>
<td>(optional) a value for the menu item. You need to set either the <b>value</b> or <b>html</b> property to the item</td>
</tr>
<tr>
<td><b>items</b></td>
<td>(optional) an array of children controls (note that all the children should have the type <i>menuItem</i>)</td>
</tr>
<tr>
<td><b>count</b></td>
<td>(optional) a badge with a number</td>
</tr>
<tr>
<td><b>countColor</b></td>
<td>(optional) the color of a badge with number: "danger" | "secondary" | "primary" | "success" </td>
</tr>
<tr>
<td><b>hotkey</b></td>
<td>(optional) the name of a keyboard shortcut for a menu item</td>
</tr>
<tr>
<td><b>html</b></td>
<td>(optional) a string with HTML that should be inserted into the menu item</td>
</tr>
<tr>
<td><b>icon</b></td>
<td>(optional) the name of an <a href="../../../menu/customization">icon</a> from the used icon font</td>
</tr>
<tr>
<td><b>tooltip</b></td>
<td>(optional) a tooltip for the menuItem</td>
</tr>
<tr>
<td><b>css</b></td>
<td>(optional) adds style classes</td>
</tr>
<tr>
<td><b>disabled</b></td>
<td>(optional) defines whether an item is disabled</td>
</tr>
<tr>
<td><b>hidden</b></td>
<td>(optional) defines whether a control is hidden</td>
</tr>
</tbody>
</table>

Expand Down
Loading
Loading