@instructure/ui-navigation 8.23.1-snapshot.9 → 8.24.1-snapshot.17

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.
Files changed (51) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/es/AppNav/AppNavLocator.js +2 -1
  3. package/es/AppNav/Item/AppNavItemLocator.js +2 -1
  4. package/es/AppNav/Item/index.js +1 -3
  5. package/es/AppNav/Item/props.js +1 -42
  6. package/es/AppNav/index.js +12 -10
  7. package/es/AppNav/props.js +0 -46
  8. package/es/Navigation/NavigationItem/NavigationItemLocator.js +4 -2
  9. package/es/Navigation/NavigationItem/index.js +3 -2
  10. package/es/Navigation/NavigationItem/props.js +0 -31
  11. package/es/Navigation/NavigationLocator.js +2 -1
  12. package/es/Navigation/index.js +9 -6
  13. package/es/Navigation/props.js +0 -27
  14. package/lib/AppNav/AppNavLocator.js +1 -0
  15. package/lib/AppNav/Item/AppNavItemLocator.js +1 -0
  16. package/lib/AppNav/Item/index.js +1 -3
  17. package/lib/AppNav/Item/props.js +1 -42
  18. package/lib/AppNav/index.js +11 -9
  19. package/lib/AppNav/props.js +0 -46
  20. package/lib/Navigation/NavigationItem/NavigationItemLocator.js +2 -0
  21. package/lib/Navigation/NavigationItem/index.js +3 -2
  22. package/lib/Navigation/NavigationItem/props.js +0 -31
  23. package/lib/Navigation/NavigationLocator.js +1 -0
  24. package/lib/Navigation/index.js +11 -6
  25. package/lib/Navigation/props.js +0 -27
  26. package/package.json +24 -24
  27. package/src/AppNav/Item/index.tsx +2 -8
  28. package/src/AppNav/Item/props.ts +37 -32
  29. package/src/AppNav/index.tsx +21 -35
  30. package/src/AppNav/props.ts +41 -41
  31. package/src/Navigation/NavigationItem/index.tsx +2 -4
  32. package/src/Navigation/NavigationItem/props.ts +26 -26
  33. package/src/Navigation/index.tsx +14 -17
  34. package/src/Navigation/props.ts +24 -24
  35. package/tsconfig.build.tsbuildinfo +1 -1
  36. package/types/AppNav/Item/index.d.ts +10 -10
  37. package/types/AppNav/Item/index.d.ts.map +1 -1
  38. package/types/AppNav/Item/props.d.ts +37 -5
  39. package/types/AppNav/Item/props.d.ts.map +1 -1
  40. package/types/AppNav/index.d.ts +20 -13
  41. package/types/AppNav/index.d.ts.map +1 -1
  42. package/types/AppNav/props.d.ts +43 -4
  43. package/types/AppNav/props.d.ts.map +1 -1
  44. package/types/Navigation/NavigationItem/index.d.ts +3 -3
  45. package/types/Navigation/NavigationItem/index.d.ts.map +1 -1
  46. package/types/Navigation/NavigationItem/props.d.ts +26 -2
  47. package/types/Navigation/NavigationItem/props.d.ts.map +1 -1
  48. package/types/Navigation/index.d.ts +14 -14
  49. package/types/Navigation/index.d.ts.map +1 -1
  50. package/types/Navigation/props.d.ts +24 -3
  51. package/types/Navigation/props.d.ts.map +1 -1
@@ -7,16 +7,17 @@ import type { AppNavItemProps } from './props';
7
7
  parent: AppNav
8
8
  id: AppNav.Item
9
9
  ---
10
+ @tsProps
10
11
  @module Item
11
12
  **/
12
13
  declare class Item extends Component<AppNavItemProps> {
13
14
  static readonly componentId = "AppNav.Item";
14
15
  static allowedProps: readonly (keyof {
15
- renderLabel: React.ReactNode | ((...args: any[]) => any);
16
- renderAfter?: React.ReactNode | ((...args: any[]) => any);
17
- renderIcon?: React.ReactNode | ((...args: any[]) => any);
16
+ renderLabel: React.ReactNode | (() => React.ReactNode);
17
+ renderAfter?: React.ReactNode | (() => React.ReactNode);
18
+ renderIcon?: React.ReactNode | (() => React.ReactNode);
18
19
  href?: string | undefined;
19
- onClick?: ((...args: any[]) => any) | undefined;
20
+ onClick?: ((event: React.MouseEvent<Element, MouseEvent>) => void) | undefined;
20
21
  isSelected?: boolean | undefined;
21
22
  elementRef?: ((element: Element | null) => void) | undefined;
22
23
  as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
@@ -24,11 +25,11 @@ declare class Item extends Component<AppNavItemProps> {
24
25
  isDisabled?: boolean | undefined;
25
26
  })[];
26
27
  static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
27
- renderLabel: React.ReactNode | ((...args: any[]) => any);
28
- renderAfter?: React.ReactNode | ((...args: any[]) => any);
29
- renderIcon?: React.ReactNode | ((...args: any[]) => any);
28
+ renderLabel: React.ReactNode | (() => React.ReactNode);
29
+ renderAfter?: React.ReactNode | (() => React.ReactNode);
30
+ renderIcon?: React.ReactNode | (() => React.ReactNode);
30
31
  href?: string | undefined;
31
- onClick?: ((...args: any[]) => any) | undefined;
32
+ onClick?: ((event: React.MouseEvent<Element, MouseEvent>) => void) | undefined;
32
33
  isSelected?: boolean | undefined;
33
34
  elementRef?: ((element: Element | null) => void) | undefined;
34
35
  as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
@@ -37,7 +38,6 @@ declare class Item extends Component<AppNavItemProps> {
37
38
  }>;
38
39
  static defaultProps: {
39
40
  readonly children: null;
40
- readonly onClick: (event: any) => void;
41
41
  readonly isSelected: false;
42
42
  readonly cursor: "pointer";
43
43
  readonly isDisabled: false;
@@ -46,7 +46,7 @@ declare class Item extends Component<AppNavItemProps> {
46
46
  componentDidMount(): void;
47
47
  componentDidUpdate(): void;
48
48
  handleRef: (el: Element | null) => void;
49
- handleClick: (e: any) => void;
49
+ handleClick: (e: React.MouseEvent<Element>) => void;
50
50
  render(): jsx.JSX.Element;
51
51
  }
52
52
  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;AAexC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAG9C;;;;;;GAMG;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;;;;;;MAOT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,iBAAiB;IAIjB,kBAAkB;IAIlB,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAGD,WAAW,mBASV;IAED,MAAM;CAgDP;AAED,eAAe,IAAI,CAAA;AACnB,OAAO,EAAE,IAAI,EAAE,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;AAexC,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,OAAO,CAAC,UAS1C;IAED,MAAM;CA4CP;AAED,eAAe,IAAI,CAAA;AACnB,OAAO,EAAE,IAAI,EAAE,CAAA"}
@@ -1,17 +1,49 @@
1
- /// <reference types="react" />
2
1
  import type { AsElementType, PropValidators, AppNavItemTheme, OtherHTMLAttributes } from '@instructure/shared-types';
3
2
  import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
4
3
  import type { Cursor } from '@instructure/ui-prop-types';
4
+ import React from 'react';
5
5
  declare type AppNavItemOwnProps = {
6
- renderLabel: React.ReactNode | ((...args: any[]) => any);
7
- renderAfter?: React.ReactNode | ((...args: any[]) => any);
8
- renderIcon?: React.ReactNode | ((...args: any[]) => any);
6
+ /**
7
+ * The text to display. If the `icon` prop is used, label text must be wrapped
8
+ * in `ScreenReaderContent`.
9
+ */
10
+ renderLabel: React.ReactNode | (() => React.ReactNode);
11
+ /**
12
+ * Content to display after the renderLabel text, such as a badge
13
+ */
14
+ renderAfter?: React.ReactNode | (() => React.ReactNode);
15
+ /**
16
+ * The visual to display (ex. an Image, Logo, Avatar, or Icon)
17
+ */
18
+ renderIcon?: React.ReactNode | (() => React.ReactNode);
19
+ /**
20
+ * If the item goes to a new page, pass an href
21
+ */
9
22
  href?: string;
10
- onClick?: (...args: any[]) => any;
23
+ /**
24
+ * If the item does not go to a new page, pass an onClick
25
+ */
26
+ onClick?: (event: React.MouseEvent<Element>) => void;
27
+ /**
28
+ * Denotes which item is currently selected
29
+ */
11
30
  isSelected?: boolean;
31
+ /**
32
+ * provides a reference to the underlying focusable (`button` or `a`) element
33
+ */
12
34
  elementRef?: (element: Element | null) => void;
35
+ /**
36
+ * The element type to render as (will default to `<a>` if href is provided)
37
+ */
13
38
  as?: AsElementType;
39
+ /**
40
+ * Specify the mouse cursor to use on :hover.
41
+ * The `pointer` cursor is used by default.
42
+ */
14
43
  cursor?: Cursor;
44
+ /**
45
+ * Disables the link or button visually and functionally
46
+ */
15
47
  isDisabled?: boolean;
16
48
  };
17
49
  declare type PropKeys = keyof AppNavItemOwnProps;
@@ -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;AAExD,aAAK,kBAAkB,GAAG;IACxB,WAAW,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACxD,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACzD,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACxD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,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,CA2CvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAWnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,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;AAEzB,aAAK,kBAAkB,GAAG;IACxB;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACtD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACvD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACtD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;IACpD;;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"}
@@ -1,36 +1,43 @@
1
1
  /** @jsx jsx */
2
2
  import { Component } from 'react';
3
3
  import { jsx } from '@instructure/emotion';
4
+ import type { Debounced } from '@instructure/debounce';
4
5
  import { Item } from './Item';
5
6
  import type { AppNavProps } from './props';
7
+ import { AppNavItemProps } from './Item/props';
6
8
  /**
7
9
  ---
8
10
  category: components
9
11
  ---
12
+ @tsProps
10
13
  **/
11
14
  declare class AppNav extends Component<AppNavProps> {
12
15
  static readonly componentId = "AppNav";
13
16
  static allowedProps: readonly (keyof {
14
17
  screenReaderLabel: string;
15
18
  debounce?: number | undefined;
16
- renderBeforeItems?: import("react").ReactNode | ((...args: any[]) => any);
17
- renderAfterItems?: import("react").ReactNode | ((...args: any[]) => any);
19
+ renderBeforeItems?: import("react").ReactNode | (() => import("react").ReactNode);
20
+ renderAfterItems?: import("react").ReactNode | (() => import("react").ReactNode);
18
21
  margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
19
22
  elementRef?: ((element: Element | null) => void) | undefined;
20
- renderTruncateLabel?: import("react").ReactNode | ((...args: any[]) => any);
21
- onUpdate?: ((...args: any[]) => any) | undefined;
23
+ renderTruncateLabel?: import("react").ReactNode | (() => import("react").ReactNode);
24
+ onUpdate?: (({ visibleItemsCount }: {
25
+ visibleItemsCount: number;
26
+ }) => void) | undefined;
22
27
  visibleItemsCount?: number | undefined;
23
28
  children?: import("react").ReactNode;
24
29
  })[];
25
30
  static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
26
31
  screenReaderLabel: string;
27
32
  debounce?: number | undefined;
28
- renderBeforeItems?: import("react").ReactNode | ((...args: any[]) => any);
29
- renderAfterItems?: import("react").ReactNode | ((...args: any[]) => any);
33
+ renderBeforeItems?: import("react").ReactNode | (() => import("react").ReactNode);
34
+ renderAfterItems?: import("react").ReactNode | (() => import("react").ReactNode);
30
35
  margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
31
36
  elementRef?: ((element: Element | null) => void) | undefined;
32
- renderTruncateLabel?: import("react").ReactNode | ((...args: any[]) => any);
33
- onUpdate?: ((...args: any[]) => any) | undefined;
37
+ renderTruncateLabel?: import("react").ReactNode | (() => import("react").ReactNode);
38
+ onUpdate?: (({ visibleItemsCount }: {
39
+ visibleItemsCount: number;
40
+ }) => void) | undefined;
34
41
  visibleItemsCount?: number | undefined;
35
42
  children?: import("react").ReactNode;
36
43
  }>;
@@ -38,9 +45,7 @@ declare class AppNav extends Component<AppNavProps> {
38
45
  children: null;
39
46
  debounce: number;
40
47
  margin: string;
41
- elementRef: (el: any) => void;
42
48
  renderTruncateLabel: () => string;
43
- onUpdate: () => void;
44
49
  visibleItemsCount: number;
45
50
  };
46
51
  static Item: typeof Item;
@@ -48,7 +53,9 @@ declare class AppNav extends Component<AppNavProps> {
48
53
  isMeasuring: boolean;
49
54
  };
50
55
  ref: Element | null;
51
- _list: null;
56
+ _list: HTMLUListElement | null;
57
+ _debounced?: Debounced;
58
+ _resizeListener?: ResizeObserver;
52
59
  componentDidMount(): void;
53
60
  componentDidUpdate(): void;
54
61
  componentWillUnmount(): void;
@@ -57,8 +64,8 @@ declare class AppNav extends Component<AppNavProps> {
57
64
  };
58
65
  handleResize: () => void;
59
66
  handleRef: (el: Element | null) => void;
60
- renderListItem(item: any, isMenuTrigger: any, key: any): jsx.JSX.Element;
61
- renderMenu(items: any): jsx.JSX.Element;
67
+ renderListItem(item: React.ReactNode, isMenuTrigger: boolean, key?: number): jsx.JSX.Element;
68
+ renderMenu(items: React.ComponentElement<AppNavItemProps, Item>[]): jsx.JSX.Element;
62
69
  render(): jsx.JSX.Element;
63
70
  }
64
71
  export { AppNav };
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/AppNav/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAY,SAAS,EAAE,MAAM,OAAO,CAAA;AAE3C,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAUrD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAI7B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAG1C;;;;GAIG;AACH,cAEM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,YAAY;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;MASlB;IAED,MAAM,CAAC,IAAI,cAAO;IAElB,KAAK;;MAEJ;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAC1B,KAAK,OAAO;IAEZ,iBAAiB;IA2BjB,kBAAkB;IAIlB,oBAAoB;IAcpB,YAAY;;MA8BX;IAED,YAAY,aAQX;IAED,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAGD,cAAc,CAAC,IAAI,KAAA,EAAE,aAAa,KAAA,EAAE,GAAG,KAAA;IAgBvC,UAAU,CAAC,KAAK,KAAA;IAiChB,MAAM;CAmDP;AAED,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,eAAe,MAAM,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/AppNav/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAY,SAAS,EAAE,MAAM,OAAO,CAAA;AAE3C,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAKtD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAI7B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAE9C;;;;;GAKG;AACH,cAEM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,YAAY;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,MAAM,CAAC,IAAI,cAAO;IAElB,KAAK;;MAEJ;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAC1B,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAO;IACrC,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,eAAe,CAAC,EAAE,cAAc,CAAA;IAEhC,iBAAiB;IAuBjB,kBAAkB;IAIlB,oBAAoB;IAUpB,YAAY;;MA6BX;IAED,YAAY,aASX;IAED,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM;IAc1E,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE;IA8BjE,MAAM;CAiDP;AAED,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,eAAe,MAAM,CAAA"}
@@ -2,15 +2,54 @@ 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
4
  declare type AppNavOwnProps = {
5
+ /**
6
+ * Screenreader label for the overall navigation
7
+ */
5
8
  screenReaderLabel: string;
9
+ /**
10
+ * The rate (in ms) the component responds to container resizing or
11
+ * an update to one of its child items
12
+ */
6
13
  debounce?: number;
7
- renderBeforeItems?: React.ReactNode | ((...args: any[]) => any);
8
- renderAfterItems?: React.ReactNode | ((...args: any[]) => any);
14
+ /**
15
+ * Content to display before the navigation items, such as a logo
16
+ */
17
+ renderBeforeItems?: React.ReactNode | (() => React.ReactNode);
18
+ /**
19
+ * Content to display after the navigation items, aligned to the far end
20
+ * of the navigation
21
+ */
22
+ renderAfterItems?: React.ReactNode | (() => React.ReactNode);
23
+ /**
24
+ * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
25
+ * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
26
+ * familiar CSS-like shorthand. For example: `margin="small auto large"`.
27
+ */
9
28
  margin?: Spacing;
29
+ /**
30
+ * Provides a reference to the underlying nav element
31
+ */
10
32
  elementRef?: (element: Element | null) => void;
11
- renderTruncateLabel?: React.ReactNode | ((...args: any[]) => any);
12
- onUpdate?: (...args: any[]) => any;
33
+ /**
34
+ * Customize the text displayed in the menu trigger when links overflow
35
+ * the overall nav width.
36
+ */
37
+ renderTruncateLabel?: React.ReactNode | (() => React.ReactNode);
38
+ /**
39
+ * Called whenever the navigation items are updated or the size of
40
+ * the navigation changes. Passes in the `visibleItemsCount` as
41
+ * a parameter.
42
+ */
43
+ onUpdate?: ({ visibleItemsCount }: {
44
+ visibleItemsCount: number;
45
+ }) => void;
46
+ /**
47
+ * Sets the number of navigation items that are visible.
48
+ */
13
49
  visibleItemsCount?: number;
50
+ /**
51
+ * Only accepts `AppNav.Item` as children
52
+ */
14
53
  children?: React.ReactNode;
15
54
  };
16
55
  declare type PropKeys = keyof AppNavOwnProps;
@@ -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;AAElC,aAAK,cAAc,GAAG;IACpB,iBAAiB,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC/D,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC9D,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,mBAAmB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACjE,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,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,CAgDvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAWnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,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;AAElC,aAAK,cAAc,GAAG;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAC7D;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAC5D;;;;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,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAC/D;;;;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"}
@@ -7,6 +7,7 @@ import type { NavigationItemProps } from './props';
7
7
  parent: Navigation
8
8
  id: Navigation.Item
9
9
  ---
10
+ @tsProps
10
11
  **/
11
12
  declare class NavigationItem extends Component<NavigationItemProps> {
12
13
  static readonly componentId = "Navigation.Item";
@@ -16,7 +17,7 @@ declare class NavigationItem extends Component<NavigationItemProps> {
16
17
  label: import("react").ReactNode;
17
18
  as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
18
19
  href?: string | undefined;
19
- onClick?: ((...args: any[]) => any) | undefined;
20
+ onClick?: ((event: import("react").MouseEvent<Element, MouseEvent>) => void) | undefined;
20
21
  selected?: boolean | undefined;
21
22
  minimized?: boolean | undefined;
22
23
  })[];
@@ -26,13 +27,12 @@ declare class NavigationItem extends Component<NavigationItemProps> {
26
27
  label: import("react").ReactNode;
27
28
  as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
28
29
  href?: string | undefined;
29
- onClick?: ((...args: any[]) => any) | undefined;
30
+ onClick?: ((event: import("react").MouseEvent<Element, MouseEvent>) => void) | undefined;
30
31
  selected?: boolean | undefined;
31
32
  minimized?: boolean | undefined;
32
33
  }>;
33
34
  static defaultProps: {
34
35
  readonly as: "a";
35
- readonly onClick: (e: any, selected: any) => void;
36
36
  readonly selected: false;
37
37
  readonly minimized: false;
38
38
  };
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Navigation/NavigationItem/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAGlD;;;;;GAKG;AACH,cAEM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,YAAY;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;MAMT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAM9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,UAAU,CAAC,MAAM,EAAE,OAAO;IA4B1B,MAAM;CAYP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Navigation/NavigationItem/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAGlD;;;;;;GAMG;AACH,cAEM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,YAAY;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;MAIT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAM9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,UAAU,CAAC,MAAM,EAAE,OAAO;IA2B1B,MAAM;CAYP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
@@ -1,14 +1,38 @@
1
- /// <reference types="react" />
1
+ import React from 'react';
2
2
  import type { AsElementType, PropValidators, NavigationItemTheme, OtherHTMLAttributes } from '@instructure/shared-types';
3
3
  import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
4
4
  declare type NavigationItemOwnProps = {
5
+ /**
6
+ * The reference to the underlying HTML element
7
+ */
5
8
  elementRef?: (el: Element | null) => void;
9
+ /**
10
+ * The visual to display (ex. an Image, Logo, Avatar, or Icon)
11
+ */
6
12
  icon: React.ReactNode;
13
+ /**
14
+ * The text to display for the Navigation Link
15
+ */
7
16
  label: React.ReactNode;
17
+ /**
18
+ * The element type to render as (will default to `<a>` if href is provided)
19
+ */
8
20
  as?: AsElementType;
21
+ /**
22
+ * If the NavigationItem goes to a new page, pass an href
23
+ */
9
24
  href?: string;
10
- onClick?: (...args: any[]) => any;
25
+ /**
26
+ * If the NavigationItem does not go to a new page pass an onClick
27
+ */
28
+ onClick?: (event: React.MouseEvent) => void;
29
+ /**
30
+ * Denotes which NavigationItem is currently selected
31
+ */
11
32
  selected?: boolean;
33
+ /**
34
+ * When minimized is set to true, the `<Navigation />` shows icons only while the text becomes a tooltip. When it is set to false, the `<Navigation />` shows text in addition to the icons
35
+ */
12
36
  minimized?: boolean;
13
37
  };
14
38
  declare type PropKeys = keyof NavigationItemOwnProps;
@@ -1 +1 @@
1
- {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Navigation/NavigationItem/props.ts"],"names":[],"mappings":";AAyBA,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,sBAAsB,GAAG;IAC5B,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IACzC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAA;IACrB,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,sBAAsB,CAAA;AAE5C,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,mBAAmB,GAAG,sBAAsB,GAC/C,cAAc,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,GACxD,mBAAmB,CAAC,sBAAsB,CAAC,CAAA;AAE7C,aAAK,mBAAmB,GAAG,cAAc,CAAC,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;AAE9E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAiCvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
1
+ {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Navigation/NavigationItem/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,sBAAsB,GAAG;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IACzC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAA;IACrB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAA;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,sBAAsB,CAAA;AAE5C,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,mBAAmB,GAAG,sBAAsB,GAC/C,cAAc,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,GACxD,mBAAmB,CAAC,sBAAsB,CAAC,CAAA;AAE7C,aAAK,mBAAmB,GAAG,cAAc,CAAC,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;AAE9E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CASvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { Component } from 'react';
2
+ import React, { Component } from 'react';
3
3
  import { jsx } from '@instructure/emotion';
4
4
  import { NavigationItem } from './NavigationItem';
5
5
  import type { NavigationProps, NavigationState } from './props';
@@ -7,51 +7,51 @@ import type { NavigationProps, NavigationState } from './props';
7
7
  ---
8
8
  category: components/deprecated
9
9
  ---
10
+ @tsProps
10
11
  **/
11
12
  declare class Navigation extends Component<NavigationProps, NavigationState> {
12
13
  static readonly componentId = "Navigation";
13
14
  static allowedProps: readonly (keyof {
14
- minimized?: any;
15
+ minimized?: boolean | undefined;
15
16
  defaultMinimized?: boolean | undefined;
16
- onMinimized?: ((...args: any[]) => any) | undefined;
17
+ onMinimized?: ((event: React.SyntheticEvent<Element, Event>, minimized: boolean) => void) | undefined;
17
18
  label: string;
18
19
  toggleLabel: {
19
20
  expandedLabel?: string | undefined;
20
21
  minimizedLabel?: string | undefined;
21
22
  };
22
23
  href?: string | undefined;
23
- onClick?: ((...args: any[]) => any) | undefined;
24
- children?: import("react").ReactNode;
24
+ onClick?: ((event: React.MouseEvent<Element, MouseEvent>) => void) | undefined;
25
+ children?: React.ReactNode;
25
26
  })[];
26
27
  static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
27
- minimized?: any;
28
+ minimized?: boolean | undefined;
28
29
  defaultMinimized?: boolean | undefined;
29
- onMinimized?: ((...args: any[]) => any) | undefined;
30
+ onMinimized?: ((event: React.SyntheticEvent<Element, Event>, minimized: boolean) => void) | undefined;
30
31
  label: string;
31
32
  toggleLabel: {
32
33
  expandedLabel?: string | undefined;
33
34
  minimizedLabel?: string | undefined;
34
35
  };
35
36
  href?: string | undefined;
36
- onClick?: ((...args: any[]) => any) | undefined;
37
- children?: import("react").ReactNode;
37
+ onClick?: ((event: React.MouseEvent<Element, MouseEvent>) => void) | undefined;
38
+ children?: React.ReactNode;
38
39
  }>;
39
40
  static defaultProps: {
40
41
  children: null;
41
42
  defaultMinimized: boolean;
42
- onMinimized: (event: any, minimized: any) => void;
43
- onClick: (e: any) => void;
43
+ onClick: (_e: React.MouseEvent) => void;
44
44
  };
45
45
  static Item: typeof NavigationItem;
46
46
  ref: Element | null;
47
- constructor(props: any);
47
+ constructor(props: NavigationProps);
48
48
  componentDidMount(): void;
49
49
  componentDidUpdate(): void;
50
50
  get minimized(): boolean;
51
51
  isControlled(props?: Readonly<NavigationProps> & Readonly<{
52
- children?: import("react").ReactNode;
52
+ children?: React.ReactNode;
53
53
  }>): boolean;
54
- handleNavToggle: (event: any) => void;
54
+ handleNavToggle: (event: React.SyntheticEvent) => void;
55
55
  renderChildren(): jsx.JSX.Element[] | null | undefined;
56
56
  toggleMessage(): string | undefined;
57
57
  render(): jsx.JSX.Element;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Navigation/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAA0B,MAAM,OAAO,CAAA;AAWzD,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;AAM/D;;;;GAIG;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;;;;;MAOlB;IAED,MAAM,CAAC,IAAI,wBAAiB;IAE5B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAGd,KAAK,KAAA;IAWjB,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,SAAS,YAKZ;IAED,YAAY,CAAC,KAAK;;MAAa;IAK/B,eAAe,uBAOd;IAED,cAAc;IASd,aAAa;IAMb,MAAM;CAiCP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAA"}
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;;MAAa;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"}
@@ -2,16 +2,37 @@ import React from 'react';
2
2
  import type { PropValidators, NavigationTheme, OtherHTMLAttributes } from '@instructure/shared-types';
3
3
  import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
4
4
  declare type NavigationOwnProps = {
5
- minimized?: any;
5
+ /**
6
+ * When minimized is set to true, the `<Navigation />` shows icons only while the text becomes a tooltip. When it is set to false, the `<Navigation />` shows text in addition to the icons
7
+ */
8
+ minimized?: boolean;
9
+ /**
10
+ * Whether the `<Navigation />` is initially minimized (uncontrolled)
11
+ */
6
12
  defaultMinimized?: boolean;
7
- onMinimized?: (...args: any[]) => any;
13
+ onMinimized?: (event: React.SyntheticEvent, minimized: boolean) => void;
14
+ /**
15
+ * Screen reader label for the main Navigation
16
+ */
8
17
  label: string;
18
+ /**
19
+ * Screen reader label for the toggle button expanded/minimized state
20
+ */
9
21
  toggleLabel: {
10
22
  expandedLabel?: string;
11
23
  minimizedLabel?: string;
12
24
  };
25
+ /**
26
+ * If the `<Navigation.Item>` goes to a new page, pass an href
27
+ */
13
28
  href?: string;
14
- onClick?: (...args: any[]) => any;
29
+ /**
30
+ * If the `<Navigation.Item>` does not go to a new page pass an onClick
31
+ */
32
+ onClick?: (event: React.MouseEvent) => void;
33
+ /**
34
+ * children of type Navigation.Item
35
+ */
15
36
  children?: React.ReactNode;
16
37
  };
17
38
  declare type NavigationState = {
@@ -1 +1 @@
1
- {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Navigation/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAUzB,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,kBAAkB,GAAG;IACxB,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE;QACX,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;IACD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,CAAA;AAED,aAAK,eAAe,GAAG;IACrB,SAAS,EAAE,OAAO,CAAA;CACnB,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,CACnC,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,CAC5D,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAiCvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
1
+ {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Navigation/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAUzB,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,OAAO,KAAK,IAAI,CAAA;IACvE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,EAAE;QACX,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;IACD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAA;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,CAAA;AAED,aAAK,eAAe,GAAG;IACrB,SAAS,EAAE,OAAO,CAAA;CACnB,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,CACnC,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,CAC5D,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAYvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}