@elliemae/ds-left-navigation 2.0.0-alpha.10 → 2.0.0-alpha.14

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 (115) hide show
  1. package/cjs/LeftNavigationContext.js +0 -4
  2. package/cjs/common/getItemBackgroundStyle.js +1 -12
  3. package/cjs/common/getLeftBorderStyle.js +3 -17
  4. package/cjs/common/getScrollbarStyle.js +1 -24
  5. package/cjs/common/index.js +0 -2
  6. package/cjs/configs/useLeftNavConfig.js +14 -21
  7. package/cjs/configs/useLeftNavItems.js +11 -11
  8. package/cjs/exported-related/ChevronItem/index.js +7 -3
  9. package/cjs/exported-related/Icon/index.js +5 -0
  10. package/cjs/exported-related/ItemRenderer/index.js +11 -10
  11. package/cjs/exported-related/ItemRenderer/styled.js +27 -27
  12. package/cjs/exported-related/ItemRenderer/usePropsWithDefaults.js +10 -3
  13. package/cjs/exported-related/Notifications/index.js +41 -41
  14. package/cjs/exported-related/OpenWindowItem/index.js +7 -3
  15. package/cjs/hooks/useExpandableOnClickHandler.js +7 -6
  16. package/cjs/hooks/useKeyboardNavigation.js +7 -7
  17. package/cjs/hooks/useOpenableOnClickHandler.js +8 -7
  18. package/cjs/hooks/useSelectFirstBodyItem.js +14 -4
  19. package/cjs/index.js +0 -1
  20. package/cjs/outOfTheBox/ItemControlledDrilldown/index.js +19 -18
  21. package/cjs/outOfTheBox/ItemControlledDrilldown/styled.js +7 -4
  22. package/cjs/outOfTheBox/ItemHeader/index.js +24 -15
  23. package/cjs/outOfTheBox/ItemHeader/styled.js +3 -4
  24. package/cjs/outOfTheBox/ItemLink/index.js +18 -24
  25. package/cjs/outOfTheBox/ItemSection/index.js +12 -10
  26. package/cjs/outOfTheBox/ItemSeparator/index.js +6 -6
  27. package/cjs/outOfTheBox/ItemSubmenu/index.js +17 -25
  28. package/cjs/outOfTheBox/ItemSubmenu/styled.js +3 -4
  29. package/cjs/outOfTheBox/ItemTextLabel/index.js +11 -9
  30. package/cjs/outOfTheBox/ItemTextLabel/styled.js +7 -4
  31. package/cjs/outOfTheBox/ItemUncontrolledDrilldown/index.js +15 -15
  32. package/cjs/outOfTheBox/ItemUncontrolledDrilldown/styled.js +7 -4
  33. package/cjs/outOfTheBox/ItemWithDate/index.js +9 -8
  34. package/cjs/outOfTheBox/ItemWithDate/styled.js +7 -4
  35. package/cjs/outOfTheBox/index.js +6 -6
  36. package/cjs/parts/LeftNavContent/index.js +5 -2
  37. package/cjs/parts/LeftNavContent/styled.js +11 -16
  38. package/cjs/parts/LeftNavContentWithScrollbar/index.js +7 -0
  39. package/cjs/parts/LeftNavFooterItem/index.js +3 -12
  40. package/cjs/parts/LeftNavFooterItem/styled.js +8 -9
  41. package/cjs/parts/LeftNavLoading/index.js +13 -10
  42. package/cjs/parts/OutOfTheBoxMapItem.js +5 -0
  43. package/cjs/prop-types.js +2 -1
  44. package/esm/LeftNavigationContext.js +0 -4
  45. package/esm/common/getItemBackgroundStyle.js +1 -12
  46. package/esm/common/getLeftBorderStyle.js +3 -17
  47. package/esm/common/getScrollbarStyle.js +1 -24
  48. package/esm/common/index.js +0 -1
  49. package/esm/configs/useLeftNavConfig.js +14 -21
  50. package/esm/configs/useLeftNavItems.js +11 -11
  51. package/esm/exported-related/ChevronItem/index.js +7 -2
  52. package/esm/exported-related/Icon/index.js +5 -0
  53. package/esm/exported-related/ItemRenderer/index.js +11 -10
  54. package/esm/exported-related/ItemRenderer/styled.js +27 -28
  55. package/esm/exported-related/ItemRenderer/usePropsWithDefaults.js +10 -3
  56. package/esm/exported-related/Notifications/index.js +41 -37
  57. package/esm/exported-related/OpenWindowItem/index.js +7 -2
  58. package/esm/hooks/useExpandableOnClickHandler.js +7 -6
  59. package/esm/hooks/useKeyboardNavigation.js +7 -7
  60. package/esm/hooks/useOpenableOnClickHandler.js +8 -7
  61. package/esm/hooks/useSelectFirstBodyItem.js +14 -4
  62. package/esm/index.js +0 -1
  63. package/esm/outOfTheBox/ItemControlledDrilldown/index.js +16 -13
  64. package/esm/outOfTheBox/ItemControlledDrilldown/styled.js +7 -4
  65. package/esm/outOfTheBox/ItemHeader/index.js +24 -15
  66. package/esm/outOfTheBox/ItemHeader/styled.js +3 -3
  67. package/esm/outOfTheBox/ItemLink/index.js +18 -24
  68. package/esm/outOfTheBox/ItemSection/index.js +12 -10
  69. package/esm/outOfTheBox/ItemSeparator/index.js +6 -6
  70. package/esm/outOfTheBox/ItemSubmenu/index.js +17 -25
  71. package/esm/outOfTheBox/ItemSubmenu/styled.js +3 -3
  72. package/esm/outOfTheBox/ItemTextLabel/index.js +11 -9
  73. package/esm/outOfTheBox/ItemTextLabel/styled.js +7 -4
  74. package/esm/outOfTheBox/ItemUncontrolledDrilldown/index.js +14 -12
  75. package/esm/outOfTheBox/ItemUncontrolledDrilldown/styled.js +7 -4
  76. package/esm/outOfTheBox/ItemWithDate/index.js +9 -8
  77. package/esm/outOfTheBox/ItemWithDate/styled.js +7 -4
  78. package/esm/outOfTheBox/index.js +6 -6
  79. package/esm/parts/LeftNavContent/index.js +5 -2
  80. package/esm/parts/LeftNavContent/styled.js +11 -16
  81. package/esm/parts/LeftNavContentWithScrollbar/index.js +7 -0
  82. package/esm/parts/LeftNavFooterItem/index.js +2 -10
  83. package/esm/parts/LeftNavFooterItem/styled.js +3 -4
  84. package/esm/parts/LeftNavLoading/index.js +13 -10
  85. package/esm/parts/OutOfTheBoxMapItem.js +5 -0
  86. package/esm/prop-types.js +2 -1
  87. package/package.json +12 -16
  88. package/types/LeftNavigation.d.ts +46 -11
  89. package/types/LeftNavigationContext.d.ts +0 -4
  90. package/types/common/index.d.ts +0 -1
  91. package/types/exported-related/ItemRenderer/styled.d.ts +3 -2
  92. package/types/hooks/useKeyboardNavigation.d.ts +1 -1
  93. package/types/hooks/useSelectFirstBodyItem.d.ts +1 -1
  94. package/types/index.d.d.ts +8 -2
  95. package/types/index.d.ts +1 -2
  96. package/types/outOfTheBox/ItemControlledDrilldown/styled.d.ts +2 -2
  97. package/types/outOfTheBox/ItemHeader/styled.d.ts +2 -2
  98. package/types/outOfTheBox/ItemLink/styled.d.ts +1 -1
  99. package/types/outOfTheBox/ItemSection/styled.d.ts +3 -3
  100. package/types/outOfTheBox/ItemSubmenu/styled.d.ts +2 -2
  101. package/types/outOfTheBox/ItemTextLabel/styled.d.ts +1 -1
  102. package/types/outOfTheBox/ItemUncontrolledDrilldown/styled.d.ts +2 -2
  103. package/types/outOfTheBox/ItemWithDate/styled.d.ts +2 -2
  104. package/types/parts/LeftNavContent/styled.d.ts +7 -11
  105. package/types/parts/LeftNavContentWithScrollbar/index.d.ts +1 -0
  106. package/types/parts/LeftNavFooterItem/styled.d.ts +10 -6
  107. package/types/prop-types.d.ts +87 -18
  108. package/cjs/common/getFocusedByKeyboardStyle.js +0 -23
  109. package/cjs/configs/useGlobalKeyListeners.js +0 -31
  110. package/cjs/package.json +0 -4
  111. package/esm/common/getFocusedByKeyboardStyle.js +0 -19
  112. package/esm/configs/useGlobalKeyListeners.js +0 -22
  113. package/esm/package.json +0 -4
  114. package/types/common/getFocusedByKeyboardStyle.d.ts +0 -4
  115. package/types/configs/useGlobalKeyListeners.d.ts +0 -6
@@ -2,17 +2,13 @@ declare type LeftNavProps = {
2
2
  expanded: boolean;
3
3
  expandedWidth: string;
4
4
  };
5
- export declare const StyledLeftNavExpandAnimationWrapper: import("styled-components").StyledComponent<"nav", any, LeftNavProps, never>;
6
- export declare const StyledLeftNavAreasContainer: import("styled-components").StyledComponent<"div", any, LeftNavProps, never>;
7
- export declare const StyledLeftNavHeaderArea: import("styled-components").StyledComponent<"div", any, {
5
+ export declare const StyledLeftNavExpandAnimationWrapper: import("styled-components").StyledComponent<"nav", import("styled-components").DefaultTheme, LeftNavProps, never>;
6
+ export declare const StyledLeftNavAreasContainer: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, LeftNavProps, never>;
7
+ export declare const StyledLeftNavHeaderArea: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
8
+ export declare const StyledLeftNavBodyAreasContainer: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
9
+ export declare const StyledLeftNavBodyHeaderArea: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
10
+ export declare const StyledLeftNavBodyItemsArea: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {
8
11
  selected: boolean;
9
12
  }, never>;
10
- export declare const StyledLeftNavBodyAreasContainer: import("styled-components").StyledComponent<"div", any, {}, never>;
11
- export declare const StyledLeftNavBodyHeaderArea: import("styled-components").StyledComponent<"div", any, {
12
- selected: boolean;
13
- }, never>;
14
- export declare const StyledLeftNavBodyItemsArea: import("styled-components").StyledComponent<"div", any, {
15
- selected: boolean;
16
- }, never>;
17
- export declare const StyledLeftNavFooterArea: import("styled-components").StyledComponent<"div", any, {}, never>;
13
+ export declare const StyledLeftNavFooterArea: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
18
14
  export {};
@@ -1,4 +1,5 @@
1
1
  import React from 'react';
2
+ import 'overlayscrollbars/css/OverlayScrollbars.css';
2
3
  export interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {
3
4
  children?: React.ReactNode;
4
5
  }
@@ -1,10 +1,14 @@
1
1
  /// <reference types="react" />
2
- export declare const StyledFooterMenu: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>, any, {
2
+ export declare const StyledFooterMenu: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@elliemae/ds-grid/types/types").GridPropsT & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {
3
3
  theme: any;
4
4
  selected: boolean;
5
5
  }, never>;
6
- export declare const StyledItemWrapper: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>, any, {}, never>;
7
- export declare const StyledItem: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>, any, {}, never>;
8
- export declare const StyledLabel: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>, any, {}, never>;
9
- export declare const StyledSeparator: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>, any, {}, never>;
10
- export declare const StyledMenuCollapse: import("styled-components").StyledComponent<(rest: any) => JSX.Element, any, {}, never>;
6
+ export declare const StyledItemWrapper: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@elliemae/ds-grid/types/types").GridPropsT & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {}, never>;
7
+ export declare const StyledItem: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@elliemae/ds-grid/types/types").GridPropsT & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {
8
+ theme: any;
9
+ selected: boolean;
10
+ opened: boolean;
11
+ }, never>;
12
+ export declare const StyledLabel: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@elliemae/ds-grid/types/types").GridPropsT & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {}, never>;
13
+ export declare const StyledSeparator: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@elliemae/ds-grid/types/types").GridPropsT & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {}, never>;
14
+ export declare const StyledMenuCollapse: import("styled-components").StyledComponent<(rest: any) => JSX.Element, import("styled-components").DefaultTheme, {}, never>;
@@ -1,22 +1,91 @@
1
+ /// <reference path="../../../../shared/typings/react-desc.d.ts" />
2
+ /// <reference types="react" />
1
3
  export declare const leftNavItemProps: {
2
- type: any;
3
- dsId: any;
4
- Component: any;
5
- CollapsedComponent: any;
6
- itemOpts: any;
4
+ type: {
5
+ defaultValue<T = unknown>(arg: T): {
6
+ deprecated: import("react-desc").PropTypesDescValidator;
7
+ };
8
+ isRequired: import("react-desc").PropTypesDescValidator;
9
+ };
10
+ dsId: {
11
+ defaultValue<T = unknown>(arg: T): {
12
+ deprecated: import("react-desc").PropTypesDescValidator;
13
+ };
14
+ isRequired: import("react-desc").PropTypesDescValidator;
15
+ };
16
+ Component: {
17
+ defaultValue<T = unknown>(arg: T): {
18
+ deprecated: import("react-desc").PropTypesDescValidator;
19
+ };
20
+ isRequired: import("react-desc").PropTypesDescValidator;
21
+ };
22
+ CollapsedComponent: {
23
+ defaultValue<T = unknown>(arg: T): {
24
+ deprecated: import("react-desc").PropTypesDescValidator;
25
+ };
26
+ isRequired: import("react-desc").PropTypesDescValidator;
27
+ };
28
+ itemOpts: {
29
+ defaultValue<T = unknown>(arg: T): {
30
+ deprecated: import("react-desc").PropTypesDescValidator;
31
+ };
32
+ isRequired: import("react-desc").PropTypesDescValidator;
33
+ };
7
34
  };
8
35
  export declare const leftNavigationProps: {
9
- containerProps: any;
10
- expanded: any;
11
- loading: any;
12
- tabIndex: any;
13
- openedItem: any;
14
- footerLabel: any;
15
- onFooterExpand: any;
16
- onFooterClose: any;
17
- onSelectedChange: any;
18
- onFocusChange: any;
19
- items: any;
36
+ containerProps: {
37
+ deprecated: import("react-desc").PropTypesDescValidator;
38
+ };
39
+ expanded: {
40
+ deprecated: import("react-desc").PropTypesDescValidator;
41
+ };
42
+ loading: {
43
+ deprecated: import("react-desc").PropTypesDescValidator;
44
+ };
45
+ tabIndex: {
46
+ deprecated: import("react-desc").PropTypesDescValidator;
47
+ };
48
+ openedItem: {
49
+ deprecated: import("react-desc").PropTypesDescValidator;
50
+ };
51
+ footerLabel: {
52
+ defaultValue<T = unknown>(arg: T): {
53
+ deprecated: import("react-desc").PropTypesDescValidator;
54
+ };
55
+ isRequired: import("react-desc").PropTypesDescValidator;
56
+ };
57
+ onFooterExpand: {
58
+ defaultValue<T = unknown>(arg: T): {
59
+ deprecated: import("react-desc").PropTypesDescValidator;
60
+ };
61
+ isRequired: import("react-desc").PropTypesDescValidator;
62
+ };
63
+ onFooterClose: {
64
+ defaultValue<T = unknown>(arg: T): {
65
+ deprecated: import("react-desc").PropTypesDescValidator;
66
+ };
67
+ isRequired: import("react-desc").PropTypesDescValidator;
68
+ };
69
+ onSelectedChange: {
70
+ deprecated: import("react-desc").PropTypesDescValidator;
71
+ };
72
+ onFocusChange: {
73
+ deprecated: import("react-desc").PropTypesDescValidator;
74
+ };
75
+ items: {
76
+ deprecated: import("react-desc").PropTypesDescValidator;
77
+ };
78
+ disableDefaultSelection: {
79
+ deprecated: import("react-desc").PropTypesDescValidator;
80
+ };
81
+ };
82
+ export declare const LeftNavItemPropsSchema: {
83
+ (props?: unknown): JSX.Element;
84
+ propTypes: unknown;
85
+ toTypescript: () => import("react-desc").TypescriptSchema;
86
+ };
87
+ export declare const LeftNavItemOptionsSchema: {
88
+ (props?: unknown): JSX.Element;
89
+ propTypes: unknown;
90
+ toTypescript: () => import("react-desc").TypescriptSchema;
20
91
  };
21
- export declare const LeftNavItemPropsSchema: any;
22
- export declare const LeftNavItemOptionsSchema: any;
@@ -1,23 +0,0 @@
1
- 'use strict';
2
-
3
- Object.defineProperty(exports, '__esModule', { value: true });
4
-
5
- const commonFocusedByKeyboardBorder = (props, height, width) => `
6
- &:before {
7
- content: '';
8
- position: absolute;
9
- height: ${height};
10
- width: ${width};
11
- top: 0;
12
- left: 0px;
13
- border: 1px solid ${props.theme.colors.brand[600]};
14
- pointer-events: none;
15
- }
16
- `;
17
-
18
- const getFocusedByKeyboardBorderStyle = (props, height = '100%', width = '100%') => {
19
- if (props.focused && props.focusedByKey) return commonFocusedByKeyboardBorder(props, height, width);
20
- return '';
21
- };
22
-
23
- exports.getFocusedByKeyboardBorderStyle = getFocusedByKeyboardBorderStyle;
@@ -1,31 +0,0 @@
1
- 'use strict';
2
-
3
- Object.defineProperty(exports, '__esModule', { value: true });
4
-
5
- var React = require('react');
6
-
7
- function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
8
-
9
- var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
10
-
11
- const useGlobalKeyListeners = opts => {
12
- const {
13
- setFocusedByKey
14
- } = opts;
15
- React__default["default"].useEffect(() => {
16
- const isKey = () => setFocusedByKey(true);
17
-
18
- const isClick = () => setFocusedByKey(false); // To track wheter it's keyboard focus to apply the necessary style
19
-
20
-
21
- window.addEventListener('keydown', isKey);
22
- window.addEventListener('mousedown', isClick);
23
- return () => {
24
- window.removeEventListener('keydown', isKey);
25
- window.removeEventListener('mousedown', isClick);
26
- };
27
- }, [setFocusedByKey]);
28
- };
29
-
30
- exports["default"] = useGlobalKeyListeners;
31
- exports.useGlobalKeyListeners = useGlobalKeyListeners;
package/cjs/package.json DELETED
@@ -1,4 +0,0 @@
1
- {
2
- "type": "commonjs",
3
- "sideEffects": false
4
- }
@@ -1,19 +0,0 @@
1
- const commonFocusedByKeyboardBorder = (props, height, width) => `
2
- &:before {
3
- content: '';
4
- position: absolute;
5
- height: ${height};
6
- width: ${width};
7
- top: 0;
8
- left: 0px;
9
- border: 1px solid ${props.theme.colors.brand[600]};
10
- pointer-events: none;
11
- }
12
- `;
13
-
14
- const getFocusedByKeyboardBorderStyle = (props, height = '100%', width = '100%') => {
15
- if (props.focused && props.focusedByKey) return commonFocusedByKeyboardBorder(props, height, width);
16
- return '';
17
- };
18
-
19
- export { getFocusedByKeyboardBorderStyle };
@@ -1,22 +0,0 @@
1
- import React from 'react';
2
-
3
- const useGlobalKeyListeners = opts => {
4
- const {
5
- setFocusedByKey
6
- } = opts;
7
- React.useEffect(() => {
8
- const isKey = () => setFocusedByKey(true);
9
-
10
- const isClick = () => setFocusedByKey(false); // To track wheter it's keyboard focus to apply the necessary style
11
-
12
-
13
- window.addEventListener('keydown', isKey);
14
- window.addEventListener('mousedown', isClick);
15
- return () => {
16
- window.removeEventListener('keydown', isKey);
17
- window.removeEventListener('mousedown', isClick);
18
- };
19
- }, [setFocusedByKey]);
20
- };
21
-
22
- export { useGlobalKeyListeners as default, useGlobalKeyListeners };
package/esm/package.json DELETED
@@ -1,4 +0,0 @@
1
- {
2
- "type": "module",
3
- "sideEffects": false
4
- }
@@ -1,4 +0,0 @@
1
- export declare const getFocusedByKeyboardBorderStyle: (props: {
2
- focused: boolean;
3
- focusedByKey: boolean;
4
- }, height?: string, width?: string) => string;
@@ -1,6 +0,0 @@
1
- import React from 'react';
2
- interface optsT {
3
- setFocusedByKey: React.Dispatch<boolean>;
4
- }
5
- export declare const useGlobalKeyListeners: (opts: optsT) => void;
6
- export default useGlobalKeyListeners;