@instructure/ui-navigation 8.26.2 → 8.26.4-snapshot-3
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 +15 -0
- package/package.json +24 -24
- package/src/AppNav/Item/index.tsx +2 -1
- package/src/AppNav/Item/props.ts +6 -4
- package/src/AppNav/props.ts +4 -3
- package/tsconfig.build.tsbuildinfo +1 -1
- package/types/AppNav/Item/index.d.ts +10 -9
- package/types/AppNav/Item/index.d.ts.map +1 -1
- package/types/AppNav/Item/props.d.ts +6 -4
- package/types/AppNav/Item/props.d.ts.map +1 -1
- package/types/AppNav/index.d.ts +6 -6
- package/types/AppNav/props.d.ts +4 -3
- package/types/AppNav/props.d.ts.map +1 -1
- package/types/Navigation/index.d.ts +1 -3
- package/types/Navigation/index.d.ts.map +1 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
2
|
import React, { Component } from 'react';
|
|
3
|
+
import type { ViewOwnProps } from '@instructure/ui-view';
|
|
3
4
|
import { jsx } from '@instructure/emotion';
|
|
4
5
|
import type { AppNavItemProps } from './props';
|
|
5
6
|
/**
|
|
@@ -13,11 +14,11 @@ id: AppNav.Item
|
|
|
13
14
|
declare class Item extends Component<AppNavItemProps> {
|
|
14
15
|
static readonly componentId = "AppNav.Item";
|
|
15
16
|
static allowedProps: readonly (keyof {
|
|
16
|
-
renderLabel:
|
|
17
|
-
renderAfter?:
|
|
18
|
-
renderIcon?:
|
|
17
|
+
renderLabel: import("@instructure/shared-types").Renderable<never>;
|
|
18
|
+
renderAfter?: import("@instructure/shared-types").Renderable<never>;
|
|
19
|
+
renderIcon?: import("@instructure/shared-types").Renderable<never>;
|
|
19
20
|
href?: string | undefined;
|
|
20
|
-
onClick?: ((event: React.MouseEvent<
|
|
21
|
+
onClick?: ((event: React.MouseEvent<ViewOwnProps, MouseEvent>) => void) | undefined;
|
|
21
22
|
isSelected?: boolean | undefined;
|
|
22
23
|
elementRef?: ((element: Element | null) => void) | undefined;
|
|
23
24
|
as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
|
|
@@ -25,11 +26,11 @@ declare class Item extends Component<AppNavItemProps> {
|
|
|
25
26
|
isDisabled?: boolean | undefined;
|
|
26
27
|
})[];
|
|
27
28
|
static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
|
|
28
|
-
renderLabel:
|
|
29
|
-
renderAfter?:
|
|
30
|
-
renderIcon?:
|
|
29
|
+
renderLabel: import("@instructure/shared-types").Renderable<never>;
|
|
30
|
+
renderAfter?: import("@instructure/shared-types").Renderable<never>;
|
|
31
|
+
renderIcon?: import("@instructure/shared-types").Renderable<never>;
|
|
31
32
|
href?: string | undefined;
|
|
32
|
-
onClick?: ((event: React.MouseEvent<
|
|
33
|
+
onClick?: ((event: React.MouseEvent<ViewOwnProps, MouseEvent>) => void) | undefined;
|
|
33
34
|
isSelected?: boolean | undefined;
|
|
34
35
|
elementRef?: ((element: Element | null) => void) | undefined;
|
|
35
36
|
as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
|
|
@@ -46,7 +47,7 @@ declare class Item extends Component<AppNavItemProps> {
|
|
|
46
47
|
componentDidMount(): void;
|
|
47
48
|
componentDidUpdate(): void;
|
|
48
49
|
handleRef: (el: Element | null) => void;
|
|
49
|
-
handleClick: (e: React.MouseEvent<
|
|
50
|
+
handleClick: (e: React.MouseEvent<ViewOwnProps, MouseEvent>) => void;
|
|
50
51
|
render(): jsx.JSX.Element;
|
|
51
52
|
}
|
|
52
53
|
export default Item;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/AppNav/Item/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/AppNav/Item/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAYxC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAIxD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAG9C;;;;;;;GAOG;AACH,cAEM,IAAK,SAAQ,SAAS,CAAC,eAAe,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,iBAAgB;IAE3C,MAAM,CAAC,YAAY;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;MAKT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,iBAAiB;IAIjB,kBAAkB;IAIlB,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,WAAW,MAAO,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,UAS3D;IAED,MAAM;CA4CP;AAED,eAAe,IAAI,CAAA;AACnB,OAAO,EAAE,IAAI,EAAE,CAAA"}
|
|
@@ -2,20 +2,22 @@ import type { AsElementType, PropValidators, AppNavItemTheme, OtherHTMLAttribute
|
|
|
2
2
|
import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
|
|
3
3
|
import type { Cursor } from '@instructure/ui-prop-types';
|
|
4
4
|
import React from 'react';
|
|
5
|
+
import type { ViewOwnProps } from '@instructure/ui-view';
|
|
6
|
+
import { Renderable } from '@instructure/shared-types';
|
|
5
7
|
declare type AppNavItemOwnProps = {
|
|
6
8
|
/**
|
|
7
9
|
* The text to display. If the `icon` prop is used, label text must be wrapped
|
|
8
10
|
* in `ScreenReaderContent`.
|
|
9
11
|
*/
|
|
10
|
-
renderLabel:
|
|
12
|
+
renderLabel: Renderable;
|
|
11
13
|
/**
|
|
12
14
|
* Content to display after the renderLabel text, such as a badge
|
|
13
15
|
*/
|
|
14
|
-
renderAfter?:
|
|
16
|
+
renderAfter?: Renderable;
|
|
15
17
|
/**
|
|
16
18
|
* The visual to display (ex. an Image, Logo, Avatar, or Icon)
|
|
17
19
|
*/
|
|
18
|
-
renderIcon?:
|
|
20
|
+
renderIcon?: Renderable;
|
|
19
21
|
/**
|
|
20
22
|
* If the item goes to a new page, pass an href
|
|
21
23
|
*/
|
|
@@ -23,7 +25,7 @@ declare type AppNavItemOwnProps = {
|
|
|
23
25
|
/**
|
|
24
26
|
* If the item does not go to a new page, pass an onClick
|
|
25
27
|
*/
|
|
26
|
-
onClick?: (event: React.MouseEvent<
|
|
28
|
+
onClick?: (event: React.MouseEvent<ViewOwnProps>) => void;
|
|
27
29
|
/**
|
|
28
30
|
* Denotes which item is currently selected
|
|
29
31
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/AppNav/Item/props.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/AppNav/Item/props.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEtD,aAAK,kBAAkB,GAAG;IACxB;;;OAGG;IACH,WAAW,EAAE,UAAU,CAAA;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,IAAI,CAAA;IACzD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,eAAe,GAAG,kBAAkB,GACvC,cAAc,CAAC,eAAe,EAAE,eAAe,CAAC,GAChD,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;AAEzC,aAAK,eAAe,GAAG,cAAc,CAAC,MAAM,GAAG,OAAO,CAAC,CAAA;AAEvD,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAevC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAWnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
|
package/types/AppNav/index.d.ts
CHANGED
|
@@ -16,11 +16,11 @@ declare class AppNav extends Component<AppNavProps> {
|
|
|
16
16
|
static allowedProps: readonly (keyof {
|
|
17
17
|
screenReaderLabel: string;
|
|
18
18
|
debounce?: number | undefined;
|
|
19
|
-
renderBeforeItems?: import("
|
|
20
|
-
renderAfterItems?: import("
|
|
19
|
+
renderBeforeItems?: import("@instructure/shared-types").Renderable<never>;
|
|
20
|
+
renderAfterItems?: import("@instructure/shared-types").Renderable<never>;
|
|
21
21
|
margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
|
|
22
22
|
elementRef?: ((element: Element | null) => void) | undefined;
|
|
23
|
-
renderTruncateLabel?: import("
|
|
23
|
+
renderTruncateLabel?: import("@instructure/shared-types").Renderable<never>;
|
|
24
24
|
onUpdate?: (({ visibleItemsCount }: {
|
|
25
25
|
visibleItemsCount: number;
|
|
26
26
|
}) => void) | undefined;
|
|
@@ -30,11 +30,11 @@ declare class AppNav extends Component<AppNavProps> {
|
|
|
30
30
|
static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
|
|
31
31
|
screenReaderLabel: string;
|
|
32
32
|
debounce?: number | undefined;
|
|
33
|
-
renderBeforeItems?: import("
|
|
34
|
-
renderAfterItems?: import("
|
|
33
|
+
renderBeforeItems?: import("@instructure/shared-types").Renderable<never>;
|
|
34
|
+
renderAfterItems?: import("@instructure/shared-types").Renderable<never>;
|
|
35
35
|
margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
|
|
36
36
|
elementRef?: ((element: Element | null) => void) | undefined;
|
|
37
|
-
renderTruncateLabel?: import("
|
|
37
|
+
renderTruncateLabel?: import("@instructure/shared-types").Renderable<never>;
|
|
38
38
|
onUpdate?: (({ visibleItemsCount }: {
|
|
39
39
|
visibleItemsCount: number;
|
|
40
40
|
}) => void) | undefined;
|
package/types/AppNav/props.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
|
|
3
3
|
import type { PropValidators, AppNavTheme, OtherHTMLAttributes } from '@instructure/shared-types';
|
|
4
|
+
import { Renderable } from '@instructure/shared-types';
|
|
4
5
|
declare type AppNavOwnProps = {
|
|
5
6
|
/**
|
|
6
7
|
* Screenreader label for the overall navigation
|
|
@@ -14,12 +15,12 @@ declare type AppNavOwnProps = {
|
|
|
14
15
|
/**
|
|
15
16
|
* Content to display before the navigation items, such as a logo
|
|
16
17
|
*/
|
|
17
|
-
renderBeforeItems?:
|
|
18
|
+
renderBeforeItems?: Renderable;
|
|
18
19
|
/**
|
|
19
20
|
* Content to display after the navigation items, aligned to the far end
|
|
20
21
|
* of the navigation
|
|
21
22
|
*/
|
|
22
|
-
renderAfterItems?:
|
|
23
|
+
renderAfterItems?: Renderable;
|
|
23
24
|
/**
|
|
24
25
|
* Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
|
|
25
26
|
* `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
|
|
@@ -34,7 +35,7 @@ declare type AppNavOwnProps = {
|
|
|
34
35
|
* Customize the text displayed in the menu trigger when links overflow
|
|
35
36
|
* the overall nav width.
|
|
36
37
|
*/
|
|
37
|
-
renderTruncateLabel?:
|
|
38
|
+
renderTruncateLabel?: Renderable;
|
|
38
39
|
/**
|
|
39
40
|
* Called whenever the navigation items are updated or the size of
|
|
40
41
|
* the navigation changes. Passes in the `visibleItemsCount` as
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/AppNav/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/AppNav/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEtD,aAAK,cAAc,GAAG;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,UAAU,CAAA;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAA;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,UAAU,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,iBAAiB,EAAE,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IACzE;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,WAAW,GAAG,cAAc,GAC/B,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,GACxC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AAErC,aAAK,WAAW,GAAG,cAAc,CAC7B,QAAQ,GACR,aAAa,GACb,yBAAyB,GACzB,UAAU,GACV,MAAM,GACN,kBAAkB,CACrB,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAWvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAWnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
|
|
@@ -48,9 +48,7 @@ declare class Navigation extends Component<NavigationProps, NavigationState> {
|
|
|
48
48
|
componentDidMount(): void;
|
|
49
49
|
componentDidUpdate(): void;
|
|
50
50
|
get minimized(): boolean;
|
|
51
|
-
isControlled(props?: Readonly<NavigationProps>
|
|
52
|
-
children?: React.ReactNode;
|
|
53
|
-
}>): boolean;
|
|
51
|
+
isControlled(props?: Readonly<NavigationProps>): boolean;
|
|
54
52
|
handleNavToggle: (event: React.SyntheticEvent) => void;
|
|
55
53
|
renderChildren(): jsx.JSX.Element[] | null | undefined;
|
|
56
54
|
toggleMessage(): string | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Navigation/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAA0B,MAAM,OAAO,CAAA;AAWhE,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAIjD,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAO/D;;;;;GAKG;AAEH,cAGM,UAAW,SAAQ,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAClE,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,YAAY;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;sBAIM,gBAAgB;MACxC;IAED,MAAM,CAAC,IAAI,wBAAiB;IAE5B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAEd,KAAK,EAAE,eAAe;IAUlC,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,SAAS,YAKZ;IAED,YAAY,CAAC,KAAK
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Navigation/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAA0B,MAAM,OAAO,CAAA;AAWhE,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAIjD,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAO/D;;;;;GAKG;AAEH,cAGM,UAAW,SAAQ,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAClE,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,YAAY;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;sBAIM,gBAAgB;MACxC;IAED,MAAM,CAAC,IAAI,wBAAiB;IAE5B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAEd,KAAK,EAAE,eAAe;IAUlC,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,SAAS,YAKZ;IAED,YAAY,CAAC,KAAK,4BAAa;IAI/B,eAAe,UAAW,MAAM,cAAc,UAO7C;IAED,cAAc;IASd,aAAa;IAMb,MAAM;CAiCP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAA"}
|