Skip to content

Commit

Permalink
[delete] info about navItem for Menu
Browse files Browse the repository at this point in the history
  • Loading branch information
mafanya23 committed Sep 13, 2023
1 parent a2a81c4 commit e86e905
Show file tree
Hide file tree
Showing 6 changed files with 0 additions and 205 deletions.
107 changes: 0 additions & 107 deletions docs/menu/api/api_navitem_properties.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/menu/api/api_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,6 @@ Use [TreeCollection events](tree_collection.md#events) to work with data.

A MenuItem control can possess the [following properties](menu/api/api_menuitem_properties.md).

## Menu NavItem properties

A NavItem control may have the [following properties](menu/api/api_navitem_properties.md).

## Menu Custom HTML properties

A Custom HTML control may possess the [following properties](menu/api/api_customhtml_properties.md).
Expand Down
75 changes: 0 additions & 75 deletions docs/menu/configuring_menu_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,81 +37,6 @@ menu.data.add({

See [the full list of properties](menu/api/api_menuitem_properties.md) that you can provide in the configuration object of a MenuItem control.

## NavItem

This is a default control for navigation-related components, can contain any other controls as nested items.

### Adding NavItem

A navItem can be easily added to a menu with the help of the **add()** method of Tree Collection:

~~~js
menu.data.add({
type:"navItem", value:"My NavItem"
});
~~~

**Related sample**: [Menu. Navigation type. Click or pointer (hover)](https://snippet.dhtmlx.com/uhv64cm7)

#### Properties

See [the full list of properties](menu/api/api_navitem_properties.md) that you can provide in the configuration object of a NavItem control.

### Adding an icon

A navItem can have an icon which is set through the corresponding option **icon**:

~~~js
{
type:"navItem", value:"Some",
icon:"dxi-check"
}
~~~

### Adding a badge with a number

You can add a number badge to the navItem to display information like the number of new messages. The badge is set via the **count** property:

~~~js
{
type:"navItem", value:"Some",
icon:"dxi-check",
count:10
}
~~~

### Adding HTML content

You can add a custom image into the navItem with the help of the **html** property:

~~~js
{
type: "navItem",
id: "spline",
html: "<img src='..img/chart-spline.svg'/>"
}
~~~

**Related sample**: [Menu. Item HTML content](https://snippet.dhtmlx.com/2hr77egx)

### Showing/hiding a navItem

To hide/show a navItem, you should pass the ID of the navItem to the **hide() / show()** Menu methods:

~~~js
menu.show(id);
menu.hide(id);
~~~

### Enabling/disabling a navItem

Any navItem in the menu can be enabled/disabled:

~~~js
menu.enable(id);
menu.disable(id);
~~~

## Custom HTML

This is an item that contains any custom HTML content (for example, an image, icon or other element).
Expand Down
16 changes: 0 additions & 16 deletions docs/menu/data_loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,22 +153,6 @@ This section will give you the idea of JSON format templates for separate Menu c
You can find the full list of properties of the **menuItem** object [here](menu/api/api_menuitem_properties.md).
:::

### NavItem template

~~~js
// navItem
{
type: "navItem",
value: "Some",
icon: "dxi-check",
count: 10
}
~~~

:::tip
You will find the full list of properties of the **navItem** object [here](menu/api/api_navitem_properties.md).
:::

### Custom HTML template

~~~js
Expand Down
2 changes: 0 additions & 2 deletions docs/menu/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ In this section you can find out how to initialize Menu, how to add controls ins
| Topic | Description |
| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| [MenuItem](../configuring_menu_items/#menuitem) | Learn how to add a MenuItem control into the menu ([Example](https://snippet.dhtmlx.com/qkxeer2h)) |
| [NavItem](../configuring_menu_items/#navitem) | Learn how to add a NavItem control into the menu |
| [Custom HTML](../configuring_menu_items/#custom-html) | Learn how to add an item with custom HTML content into the menu ([Example](https://snippet.dhtmlx.com/nk65jfmx)) |
| [Spacer](../configuring_menu_items/#spacer) | Learn how to add a Spacer control into the menu ([Example](https://snippet.dhtmlx.com/fjaolual)) |
| [Separator](../configuring_menu_items/#separator) | Learn how to add a Separator control into the menu ([Example](https://snippet.dhtmlx.com/71tybx5j)) |
Expand Down Expand Up @@ -124,7 +123,6 @@ In this section you can find out corresponding references of Menu and Menu contr
| [Menu events](../../category/menu-events/) | Check the list of Menu events |
| [Menu properties](../../category/menu-properties/) | Check the list of Menu properties |
| [MenuItem properties](../api/api_menuitem_properties/) | Check the list of properties of the MenuItem control |
| [NavItem properties](../api/api_navitem_properties/) | Check the list of properties of the NavItem control |
| [Custom HTML properties](../api/api_customhtml_properties/) | Check the list of properties of the Custom HTML control |
| [Separator properties](../api/api_separator_properties/) | Check the list of properties of the Separator control |
| [Spacer properties](../api/api_spacer_properties/) | Check the list of properties of the Spacer control |
Expand Down
1 change: 0 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -3166,7 +3166,6 @@ module.exports = {
],
},
"menu/api/api_menuitem_properties",
"menu/api/api_navitem_properties",
"menu/api/api_customhtml_properties",
"menu/api/api_separator_properties",
"menu/api/api_spacer_properties",
Expand Down

0 comments on commit e86e905

Please sign in to comment.