@instructure/ui-top-nav-bar 11.0.2-snapshot-0 → 11.0.2-snapshot-2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
-
## [11.0.2-snapshot-
|
|
6
|
+
## [11.0.2-snapshot-2](https://github.com/instructure/instructure-ui/compare/v11.0.1...v11.0.2-snapshot-2) (2025-10-20)
|
|
7
7
|
|
|
8
8
|
**Note:** Version bump only for package @instructure/ui-top-nav-bar
|
|
9
9
|
|
package/README.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@instructure/ui-top-nav-bar",
|
|
3
|
-
"version": "11.0.2-snapshot-
|
|
3
|
+
"version": "11.0.2-snapshot-2",
|
|
4
4
|
"description": "A UI component library made by Instructure Inc.",
|
|
5
5
|
"author": "Instructure, Inc. Engineering and Product Design",
|
|
6
6
|
"module": "./es/index.js",
|
|
@@ -24,33 +24,33 @@
|
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@babel/runtime": "^7.27.6",
|
|
27
|
-
"@instructure/console": "11.0.2-snapshot-
|
|
28
|
-
"@instructure/emotion": "11.0.2-snapshot-
|
|
29
|
-
"@instructure/shared-types": "11.0.2-snapshot-
|
|
30
|
-
"@instructure/ui-a11y-content": "11.0.2-snapshot-
|
|
31
|
-
"@instructure/ui-avatar": "11.0.2-snapshot-
|
|
32
|
-
"@instructure/ui-breadcrumb": "11.0.2-snapshot-
|
|
33
|
-
"@instructure/ui-buttons": "11.0.2-snapshot-
|
|
34
|
-
"@instructure/ui-dialog": "11.0.2-snapshot-
|
|
35
|
-
"@instructure/ui-dom-utils": "11.0.2-snapshot-
|
|
36
|
-
"@instructure/ui-drilldown": "11.0.2-snapshot-
|
|
37
|
-
"@instructure/ui-icons": "11.0.2-snapshot-
|
|
38
|
-
"@instructure/ui-link": "11.0.2-snapshot-
|
|
39
|
-
"@instructure/ui-popover": "11.0.2-snapshot-
|
|
40
|
-
"@instructure/ui-react-utils": "11.0.2-snapshot-
|
|
41
|
-
"@instructure/ui-responsive": "11.0.2-snapshot-
|
|
42
|
-
"@instructure/ui-tooltip": "11.0.2-snapshot-
|
|
43
|
-
"@instructure/ui-tray": "11.0.2-snapshot-
|
|
44
|
-
"@instructure/ui-truncate-list": "11.0.2-snapshot-
|
|
45
|
-
"@instructure/ui-utils": "11.0.2-snapshot-
|
|
46
|
-
"@instructure/ui-view": "11.0.2-snapshot-
|
|
27
|
+
"@instructure/console": "11.0.2-snapshot-2",
|
|
28
|
+
"@instructure/emotion": "11.0.2-snapshot-2",
|
|
29
|
+
"@instructure/shared-types": "11.0.2-snapshot-2",
|
|
30
|
+
"@instructure/ui-a11y-content": "11.0.2-snapshot-2",
|
|
31
|
+
"@instructure/ui-avatar": "11.0.2-snapshot-2",
|
|
32
|
+
"@instructure/ui-breadcrumb": "11.0.2-snapshot-2",
|
|
33
|
+
"@instructure/ui-buttons": "11.0.2-snapshot-2",
|
|
34
|
+
"@instructure/ui-dialog": "11.0.2-snapshot-2",
|
|
35
|
+
"@instructure/ui-dom-utils": "11.0.2-snapshot-2",
|
|
36
|
+
"@instructure/ui-drilldown": "11.0.2-snapshot-2",
|
|
37
|
+
"@instructure/ui-icons": "11.0.2-snapshot-2",
|
|
38
|
+
"@instructure/ui-link": "11.0.2-snapshot-2",
|
|
39
|
+
"@instructure/ui-popover": "11.0.2-snapshot-2",
|
|
40
|
+
"@instructure/ui-react-utils": "11.0.2-snapshot-2",
|
|
41
|
+
"@instructure/ui-responsive": "11.0.2-snapshot-2",
|
|
42
|
+
"@instructure/ui-tooltip": "11.0.2-snapshot-2",
|
|
43
|
+
"@instructure/ui-tray": "11.0.2-snapshot-2",
|
|
44
|
+
"@instructure/ui-truncate-list": "11.0.2-snapshot-2",
|
|
45
|
+
"@instructure/ui-utils": "11.0.2-snapshot-2",
|
|
46
|
+
"@instructure/ui-view": "11.0.2-snapshot-2"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@instructure/ui-axe-check": "11.0.2-snapshot-
|
|
50
|
-
"@instructure/ui-babel-preset": "11.0.2-snapshot-
|
|
51
|
-
"@instructure/ui-color-utils": "11.0.2-snapshot-
|
|
52
|
-
"@instructure/ui-scripts": "11.0.2-snapshot-
|
|
53
|
-
"@instructure/ui-themes": "11.0.2-snapshot-
|
|
49
|
+
"@instructure/ui-axe-check": "11.0.2-snapshot-2",
|
|
50
|
+
"@instructure/ui-babel-preset": "11.0.2-snapshot-2",
|
|
51
|
+
"@instructure/ui-color-utils": "11.0.2-snapshot-2",
|
|
52
|
+
"@instructure/ui-scripts": "11.0.2-snapshot-2",
|
|
53
|
+
"@instructure/ui-themes": "11.0.2-snapshot-2",
|
|
54
54
|
"@testing-library/jest-dom": "^6.6.3",
|
|
55
55
|
"@testing-library/react": "15.0.7",
|
|
56
56
|
"@testing-library/user-event": "^14.6.1",
|
package/src/TopNavBar/README.md
CHANGED
|
@@ -1198,7 +1198,7 @@ type: example
|
|
|
1198
1198
|
|
|
1199
1199
|
If there is not enough space to display all items, the list is truncated, and the hidden items are available under a dropdown menu.
|
|
1200
1200
|
|
|
1201
|
-
When a menu item has multiple levels, a submenu can be rendered by passing a [Drilldown](
|
|
1201
|
+
When a menu item has multiple levels, a submenu can be rendered by passing a [Drilldown](Drilldown) navigation via it's `renderSubmenu` prop. If a more specialized dropdown is needed, it can be configured by the `customPopoverConfig` prop (see the [Dropdowns](/#TopNavBar/#items-dropdowns) section).
|
|
1202
1202
|
|
|
1203
1203
|
The current page is highlighted, if it's id is passed via the `currentPageId` prop. (Note that it doesn't highlight items in submenus, but it highlights items hidden in truncated lists.)
|
|
1204
1204
|
|
|
@@ -1847,7 +1847,7 @@ The items can display as text, button, icon only or avatar only. The text and bu
|
|
|
1847
1847
|
|
|
1848
1848
|
Not all 4 variation are available in every container, e.g.: items with avatars can only be used in `<TopNavBar.User>`.
|
|
1849
1849
|
|
|
1850
|
-
In small viewport mode, items in `<TopNavBar.User>` and `<TopNavBar.MenuItems>` will be converted to dropdown menu items ([Drilldown](
|
|
1850
|
+
In small viewport mode, items in `<TopNavBar.User>` and `<TopNavBar.MenuItems>` will be converted to dropdown menu items ([Drilldown](Drilldown) options), thus displaying differently (e.g.: all variants display as text options and icons are not rendered). The items in `<TopNavBar.ActionItems>` will be converted to `icon` variants (and are required to have `renderIcon` prop), and the list will get truncated when there is not enough space to display all actions.
|
|
1851
1851
|
|
|
1852
1852
|
```js
|
|
1853
1853
|
---
|
|
@@ -1944,11 +1944,11 @@ type: example
|
|
|
1944
1944
|
|
|
1945
1945
|
##### Submenu
|
|
1946
1946
|
|
|
1947
|
-
The most common use case is when we want to open a submenu by clicking on the item. The `renderSubmenu` prop accepts a [Drilldown](
|
|
1947
|
+
The most common use case is when we want to open a submenu by clicking on the item. The `renderSubmenu` prop accepts a [Drilldown](Drilldown) component, and the toggle logic is handled by `TopNavBar.Item`. The submenu can have multiple levels.
|
|
1948
1948
|
|
|
1949
1949
|
##### Custom Popover
|
|
1950
1950
|
|
|
1951
|
-
If custom content needs to be displayed in the dropdown (e.g. search feature), use the `customPopoverConfig` prop. It accepts a config object of [Popover](
|
|
1951
|
+
If custom content needs to be displayed in the dropdown (e.g. search feature), use the `customPopoverConfig` prop. It accepts a config object of [Popover](Popover) component props (except `renderTrigger`, since the item itself is the trigger).
|
|
1952
1952
|
|
|
1953
1953
|
**Note**: in "smallViewport" mode items in `TopNavBar.ActionItems` can display custom popovers, but since the items in `TopNavBar.MenuItems` are converted to Drilldown options, custom popovers are not recommended to use in menu items.
|
|
1954
1954
|
|
|
@@ -1956,7 +1956,7 @@ If custom content needs to be displayed in the dropdown (e.g. search feature), u
|
|
|
1956
1956
|
|
|
1957
1957
|
The `tooltip` prop can display extra information on hover/focus. Tooltips can be useful for `variant="icon"` or `variant="avatar"` type menu items where there is no visible text.
|
|
1958
1958
|
|
|
1959
|
-
It accepts either a string or a config object containing a subset of props from [Tooltip](
|
|
1959
|
+
It accepts either a string or a config object containing a subset of props from [Tooltip](Tooltip).
|
|
1960
1960
|
|
|
1961
1961
|
**Note**: items rendered as Drilldown options don't render tooltips.
|
|
1962
1962
|
|
|
@@ -105,7 +105,7 @@ type TopNavBarItemOwnProps = {
|
|
|
105
105
|
|
|
106
106
|
/**
|
|
107
107
|
* Renders the submenu for the item.
|
|
108
|
-
* Accepts a [Drilldown](
|
|
108
|
+
* Accepts a [Drilldown](Drilldown) component.
|
|
109
109
|
* The menu toggle logic is controlled by the menu item.
|
|
110
110
|
*
|
|
111
111
|
* If you need more customization, use the `customPopoverConfig` prop.
|
|
@@ -120,7 +120,7 @@ type TopNavBarItemOwnProps = {
|
|
|
120
120
|
|
|
121
121
|
/**
|
|
122
122
|
* Configures a custom Popover for the menu item.
|
|
123
|
-
* Accepts [Popover](
|
|
123
|
+
* Accepts [Popover](Popover) props (except "renderTrigger").
|
|
124
124
|
*
|
|
125
125
|
* Use this prop for features like search, tooltips, etc., and use
|
|
126
126
|
* the `renderSubmenu` prop for the default submenu!
|
|
@@ -138,7 +138,7 @@ type TopNavBarItemOwnProps = {
|
|
|
138
138
|
* Tooltips can be useful for `variant="icon"` or `variant="avatar"` type
|
|
139
139
|
* menu items where there is no visible text.
|
|
140
140
|
*
|
|
141
|
-
* Accepts a string or a config object containing a subset of props from [Tooltip](
|
|
141
|
+
* Accepts a string or a config object containing a subset of props from [Tooltip](Tooltip).
|
|
142
142
|
*/
|
|
143
143
|
tooltip?: TopNavBarItemTooltipType
|
|
144
144
|
|
|
@@ -189,7 +189,7 @@ type TopNavBarItemOwnProps = {
|
|
|
189
189
|
) => void
|
|
190
190
|
|
|
191
191
|
/**
|
|
192
|
-
* __In desktop mode__, the callback fired when the item's submenu ([Drilldown](
|
|
192
|
+
* __In desktop mode__, the callback fired when the item's submenu ([Drilldown](Drilldown)) is toggled open/closed.
|
|
193
193
|
*/
|
|
194
194
|
onSubmenuToggle?: DrilldownProps['onToggle']
|
|
195
195
|
|