@snack-uikit/list 0.1.1-preview-57c837e3.0

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 (151) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/LICENSE +201 -0
  3. package/README.md +73 -0
  4. package/dist/components/Items/AccordionItem/AccordionItem.d.ts +2 -0
  5. package/dist/components/Items/AccordionItem/AccordionItem.js +41 -0
  6. package/dist/components/Items/AccordionItem/index.d.ts +1 -0
  7. package/dist/components/Items/AccordionItem/index.js +1 -0
  8. package/dist/components/Items/BaseItem/BaseItem.d.ts +8 -0
  9. package/dist/components/Items/BaseItem/BaseItem.js +67 -0
  10. package/dist/components/Items/BaseItem/constants.d.ts +2 -0
  11. package/dist/components/Items/BaseItem/constants.js +5 -0
  12. package/dist/components/Items/BaseItem/index.d.ts +1 -0
  13. package/dist/components/Items/BaseItem/index.js +1 -0
  14. package/dist/components/Items/BaseItem/styles.module.css +205 -0
  15. package/dist/components/Items/GroupItem/GroupItem.d.ts +2 -0
  16. package/dist/components/Items/GroupItem/GroupItem.js +9 -0
  17. package/dist/components/Items/GroupItem/index.d.ts +1 -0
  18. package/dist/components/Items/GroupItem/index.js +1 -0
  19. package/dist/components/Items/NextListItem/NextListItem.d.ts +2 -0
  20. package/dist/components/Items/NextListItem/NextListItem.js +66 -0
  21. package/dist/components/Items/NextListItem/hooks.d.ts +19 -0
  22. package/dist/components/Items/NextListItem/hooks.js +80 -0
  23. package/dist/components/Items/NextListItem/index.d.ts +1 -0
  24. package/dist/components/Items/NextListItem/index.js +1 -0
  25. package/dist/components/Items/PinGroupItem/PinGroupItem.d.ts +7 -0
  26. package/dist/components/Items/PinGroupItem/PinGroupItem.js +15 -0
  27. package/dist/components/Items/PinGroupItem/index.d.ts +1 -0
  28. package/dist/components/Items/PinGroupItem/index.js +1 -0
  29. package/dist/components/Items/PinGroupItem/styles.module.css +31 -0
  30. package/dist/components/Items/SearchItem/SearchItem.d.ts +5 -0
  31. package/dist/components/Items/SearchItem/SearchItem.js +28 -0
  32. package/dist/components/Items/SearchItem/index.d.ts +1 -0
  33. package/dist/components/Items/SearchItem/index.js +1 -0
  34. package/dist/components/Items/SearchItem/styles.module.css +11 -0
  35. package/dist/components/Items/hooks.d.ts +22 -0
  36. package/dist/components/Items/hooks.js +61 -0
  37. package/dist/components/Items/index.d.ts +9 -0
  38. package/dist/components/Items/index.js +9 -0
  39. package/dist/components/Items/styles.module.css +74 -0
  40. package/dist/components/Items/types.d.ts +43 -0
  41. package/dist/components/Items/types.js +1 -0
  42. package/dist/components/Items/utils.d.ts +17 -0
  43. package/dist/components/Items/utils.js +42 -0
  44. package/dist/components/Lists/Droplist/DropList.d.ts +2 -0
  45. package/dist/components/Lists/Droplist/DropList.js +97 -0
  46. package/dist/components/Lists/Droplist/index.d.ts +1 -0
  47. package/dist/components/Lists/Droplist/index.js +1 -0
  48. package/dist/components/Lists/List/List.d.ts +14 -0
  49. package/dist/components/Lists/List/List.js +77 -0
  50. package/dist/components/Lists/List/index.d.ts +1 -0
  51. package/dist/components/Lists/List/index.js +1 -0
  52. package/dist/components/Lists/ListPrivate/ListPrivate.d.ts +22 -0
  53. package/dist/components/Lists/ListPrivate/ListPrivate.js +41 -0
  54. package/dist/components/Lists/ListPrivate/index.d.ts +1 -0
  55. package/dist/components/Lists/ListPrivate/index.js +1 -0
  56. package/dist/components/Lists/ListPrivate/styles.module.css +46 -0
  57. package/dist/components/Lists/contexts/CollapseProvider.d.ts +6 -0
  58. package/dist/components/Lists/contexts/CollapseProvider.js +3 -0
  59. package/dist/components/Lists/contexts/ListProvider.d.ts +12 -0
  60. package/dist/components/Lists/contexts/ListProvider.js +22 -0
  61. package/dist/components/Lists/contexts/ParentListProvider.d.ts +18 -0
  62. package/dist/components/Lists/contexts/ParentListProvider.js +12 -0
  63. package/dist/components/Lists/contexts/SelectionProvider.d.ts +53 -0
  64. package/dist/components/Lists/contexts/SelectionProvider.js +61 -0
  65. package/dist/components/Lists/contexts/index.d.ts +4 -0
  66. package/dist/components/Lists/contexts/index.js +4 -0
  67. package/dist/components/Lists/hooks.d.ts +16 -0
  68. package/dist/components/Lists/hooks.js +73 -0
  69. package/dist/components/Lists/index.d.ts +4 -0
  70. package/dist/components/Lists/index.js +2 -0
  71. package/dist/components/Lists/styles.module.css +70 -0
  72. package/dist/components/Lists/types.d.ts +35 -0
  73. package/dist/components/Lists/types.js +1 -0
  74. package/dist/components/index.d.ts +2 -0
  75. package/dist/components/index.js +1 -0
  76. package/dist/helperComponents/CollapseBlockPrivate/CollapseBlockPrivate.d.ts +9 -0
  77. package/dist/helperComponents/CollapseBlockPrivate/CollapseBlockPrivate.js +20 -0
  78. package/dist/helperComponents/CollapseBlockPrivate/index.d.ts +1 -0
  79. package/dist/helperComponents/CollapseBlockPrivate/index.js +1 -0
  80. package/dist/helperComponents/CollapseBlockPrivate/styles.module.css +38 -0
  81. package/dist/helperComponents/HiddenTabButton/HiddenTabButton.d.ts +6 -0
  82. package/dist/helperComponents/HiddenTabButton/HiddenTabButton.js +17 -0
  83. package/dist/helperComponents/HiddenTabButton/index.d.ts +1 -0
  84. package/dist/helperComponents/HiddenTabButton/index.js +1 -0
  85. package/dist/helperComponents/HiddenTabButton/styles.module.css +9 -0
  86. package/dist/helperComponents/Separator/Separator.d.ts +7 -0
  87. package/dist/helperComponents/Separator/Separator.js +12 -0
  88. package/dist/helperComponents/Separator/index.d.ts +1 -0
  89. package/dist/helperComponents/Separator/index.js +1 -0
  90. package/dist/helperComponents/Separator/styles.module.css +112 -0
  91. package/dist/helperComponents/index.d.ts +3 -0
  92. package/dist/helperComponents/index.js +3 -0
  93. package/dist/index.d.ts +1 -0
  94. package/dist/index.js +1 -0
  95. package/dist/types.d.ts +12 -0
  96. package/dist/types.js +1 -0
  97. package/dist/utils.d.ts +18 -0
  98. package/dist/utils.js +69 -0
  99. package/package.json +48 -0
  100. package/src/components/Items/AccordionItem/AccordionItem.tsx +60 -0
  101. package/src/components/Items/AccordionItem/index.ts +1 -0
  102. package/src/components/Items/BaseItem/BaseItem.tsx +150 -0
  103. package/src/components/Items/BaseItem/constants.ts +7 -0
  104. package/src/components/Items/BaseItem/index.ts +1 -0
  105. package/src/components/Items/BaseItem/styles.module.scss +190 -0
  106. package/src/components/Items/GroupItem/GroupItem.tsx +17 -0
  107. package/src/components/Items/GroupItem/index.ts +1 -0
  108. package/src/components/Items/NextListItem/NextListItem.tsx +131 -0
  109. package/src/components/Items/NextListItem/hooks.ts +105 -0
  110. package/src/components/Items/NextListItem/index.ts +1 -0
  111. package/src/components/Items/PinGroupItem/PinGroupItem.tsx +28 -0
  112. package/src/components/Items/PinGroupItem/index.ts +1 -0
  113. package/src/components/Items/PinGroupItem/styles.module.scss +38 -0
  114. package/src/components/Items/SearchItem/SearchItem.tsx +52 -0
  115. package/src/components/Items/SearchItem/index.ts +1 -0
  116. package/src/components/Items/SearchItem/styles.module.scss +13 -0
  117. package/src/components/Items/hooks.tsx +101 -0
  118. package/src/components/Items/index.ts +9 -0
  119. package/src/components/Items/styles.module.scss +78 -0
  120. package/src/components/Items/types.ts +61 -0
  121. package/src/components/Items/utils.ts +69 -0
  122. package/src/components/Lists/Droplist/DropList.tsx +166 -0
  123. package/src/components/Lists/Droplist/index.ts +1 -0
  124. package/src/components/Lists/List/List.tsx +120 -0
  125. package/src/components/Lists/List/index.ts +1 -0
  126. package/src/components/Lists/ListPrivate/ListPrivate.tsx +149 -0
  127. package/src/components/Lists/ListPrivate/index.ts +1 -0
  128. package/src/components/Lists/ListPrivate/styles.module.scss +48 -0
  129. package/src/components/Lists/contexts/CollapseProvider.ts +9 -0
  130. package/src/components/Lists/contexts/ListProvider.tsx +24 -0
  131. package/src/components/Lists/contexts/ParentListProvider.tsx +35 -0
  132. package/src/components/Lists/contexts/SelectionProvider.tsx +171 -0
  133. package/src/components/Lists/contexts/index.ts +4 -0
  134. package/src/components/Lists/hooks.ts +99 -0
  135. package/src/components/Lists/index.ts +10 -0
  136. package/src/components/Lists/styles.module.scss +73 -0
  137. package/src/components/Lists/types.ts +47 -0
  138. package/src/components/index.ts +3 -0
  139. package/src/helperComponents/CollapseBlockPrivate/CollapseBlockPrivate.tsx +34 -0
  140. package/src/helperComponents/CollapseBlockPrivate/index.ts +1 -0
  141. package/src/helperComponents/CollapseBlockPrivate/styles.module.scss +51 -0
  142. package/src/helperComponents/HiddenTabButton/HiddenTabButton.tsx +27 -0
  143. package/src/helperComponents/HiddenTabButton/index.ts +1 -0
  144. package/src/helperComponents/HiddenTabButton/styles.module.scss +11 -0
  145. package/src/helperComponents/Separator/Separator.tsx +33 -0
  146. package/src/helperComponents/Separator/index.ts +1 -0
  147. package/src/helperComponents/Separator/styles.module.scss +63 -0
  148. package/src/helperComponents/index.ts +3 -0
  149. package/src/index.ts +1 -0
  150. package/src/types.ts +14 -0
  151. package/src/utils.ts +106 -0
@@ -0,0 +1,34 @@
1
+ import cn from 'classnames';
2
+ import { ReactNode } from 'react';
3
+
4
+ import { extractSupportProps, WithSupportProps } from '@snack-uikit/utils';
5
+
6
+ import styles from './styles.module.scss';
7
+
8
+ export type CollapseBlockPrivateProps = WithSupportProps<{
9
+ children: ReactNode;
10
+ header: ReactNode;
11
+ expanded: boolean;
12
+ className?: string;
13
+ }>;
14
+
15
+ // TODO: Add animation. Solution like in Accordion/Tree does not work with Scroll =(
16
+ export function CollapseBlockPrivate({ children, expanded, className, header, ...rest }: CollapseBlockPrivateProps) {
17
+ return (
18
+ <div
19
+ className={cn(styles.accordion, className)}
20
+ role='menuitem'
21
+ aria-haspopup
22
+ aria-expanded={expanded}
23
+ {...extractSupportProps(rest)}
24
+ >
25
+ {header}
26
+
27
+ <div className={styles.contentWrapper} aria-hidden={!expanded}>
28
+ <div className={styles.content} data-content>
29
+ {children}
30
+ </div>
31
+ </div>
32
+ </div>
33
+ );
34
+ }
@@ -0,0 +1 @@
1
+ export * from './CollapseBlockPrivate';
@@ -0,0 +1,51 @@
1
+ @import '@snack-uikit/figma-tokens/build/scss/components/styles-tokens-element';
2
+
3
+ $duration: 300ms;
4
+
5
+ .accordion {
6
+ display: flex;
7
+ flex-direction: column;
8
+ box-sizing: border-box;
9
+ transition: gap $duration;
10
+
11
+ &::-webkit-scrollbar {
12
+ width: 0;
13
+ }
14
+
15
+ &[aria-expanded='false'] {
16
+ gap: 0;
17
+ }
18
+ }
19
+
20
+ .contentWrapper {
21
+ box-sizing: border-box;
22
+ width: 100%;
23
+
24
+ &[aria-hidden='false'] {
25
+ > div[data-content] {
26
+ display: block;
27
+ }
28
+ }
29
+ }
30
+
31
+ .content {
32
+ position: relative;
33
+ display: none;
34
+ box-sizing: border-box;
35
+ width: 100%;
36
+
37
+ &::before {
38
+ pointer-events: none;
39
+ content: '';
40
+
41
+ position: absolute;
42
+ top: 0;
43
+ left: 0;
44
+
45
+ width: 100%;
46
+ height: 100%;
47
+
48
+ opacity: $opacity-a004;
49
+ background-color: $sys-neutral-accent-default;
50
+ }
51
+ }
@@ -0,0 +1,27 @@
1
+ import { FocusEvent, forwardRef, KeyboardEvent, RefObject, useCallback } from 'react';
2
+
3
+ import styles from './styles.module.scss';
4
+
5
+ type HiddenTabButtonProps = {
6
+ listRef: RefObject<HTMLElement>;
7
+ };
8
+
9
+ export const HiddenTabButton = forwardRef<HTMLButtonElement, HiddenTabButtonProps>(({ listRef }, ref) => {
10
+ const handleFocus = useCallback(
11
+ (e: FocusEvent<HTMLButtonElement>) => {
12
+ if (e.relatedTarget !== listRef.current) {
13
+ listRef.current?.focus();
14
+ }
15
+
16
+ e.preventDefault();
17
+ e.stopPropagation();
18
+ },
19
+ [listRef],
20
+ );
21
+
22
+ const handleKeyDown = useCallback((e: KeyboardEvent<HTMLButtonElement>) => {
23
+ e.stopPropagation();
24
+ }, []);
25
+
26
+ return <button aria-hidden ref={ref} onKeyDown={handleKeyDown} onFocus={handleFocus} className={styles.hiddenBtn} />;
27
+ });
@@ -0,0 +1 @@
1
+ export * from './HiddenTabButton';
@@ -0,0 +1,11 @@
1
+ .hiddenBtn {
2
+ position: absolute;
3
+
4
+ width: 0;
5
+ height: 0;
6
+ margin: 0;
7
+ padding: 0;
8
+
9
+ border: none;
10
+ outline: none;
11
+ }
@@ -0,0 +1,33 @@
1
+ import { Divider } from '@snack-uikit/divider';
2
+
3
+ import styles from './styles.module.scss';
4
+
5
+ export type SeparatorProps = {
6
+ label?: string;
7
+ mode?: 'primary' | 'secondary';
8
+ divider?: boolean;
9
+ size?: 's' | 'm' | 'l';
10
+ };
11
+
12
+ export function Separator({ label, divider, mode = 'secondary', size = 's' }: SeparatorProps) {
13
+ if (label) {
14
+ return (
15
+ <div className={styles.separatorWithLabel} data-size={size}>
16
+ <span className={styles.label} data-mode={mode}>
17
+ {label}
18
+ </span>
19
+ {divider && <Divider weight={mode === 'primary' ? 'regular' : 'light'} />}
20
+ </div>
21
+ );
22
+ }
23
+
24
+ if (divider) {
25
+ return (
26
+ <div className={styles.separatorWithoutLabel} data-size={size}>
27
+ <Divider weight='regular' />
28
+ </div>
29
+ );
30
+ }
31
+
32
+ return null;
33
+ }
@@ -0,0 +1 @@
1
+ export * from './Separator';
@@ -0,0 +1,63 @@
1
+ @import '@snack-uikit/figma-tokens/build/scss/components/styles-tokens-dropList';
2
+ @import '@snack-uikit/figma-tokens/build/scss/components/styles-tokens-element';
3
+
4
+ $sizes: 's', 'm', 'l';
5
+
6
+ $typography-primary: (
7
+ 's': $sans-label-m,
8
+ 'm': $sans-label-l,
9
+ 'l': $sans-title-m,
10
+ );
11
+
12
+ $typography-secondary: (
13
+ 's': $light-label-m,
14
+ 'm': $light-label-l,
15
+ 'l': $light-title-m,
16
+ );
17
+
18
+ .separatorWithLabel {
19
+ display: flex;
20
+ gap: $dimension-1m;
21
+ align-items: flex-end;
22
+ box-sizing: border-box;
23
+
24
+ @each $size in $sizes {
25
+ &[data-size='#{$size}'] {
26
+ @include composite-var($drop-list, 'item', $size, 'container-separator-subheader');
27
+
28
+ .label {
29
+ &[data-mode='primary'] {
30
+ @include composite-var(simple-var($typography-primary, $size));
31
+ }
32
+ &[data-mode='secondary'] {
33
+ @include composite-var(simple-var($typography-secondary, $size));
34
+ }
35
+ }
36
+ }
37
+ }
38
+ }
39
+
40
+ .separatorWithoutLabel {
41
+ display: flex;
42
+ align-items: flex-end;
43
+
44
+ @each $size in $sizes {
45
+ &[data-size='#{$size}'] {
46
+ @include composite-var($drop-list, 'item', $size, 'container-separator');
47
+ }
48
+ }
49
+
50
+ box-sizing: border-box;
51
+ }
52
+
53
+ .label {
54
+ flex-shrink: 0;
55
+
56
+ &[data-mode='primary'] {
57
+ color: $sys-neutral-text-main;
58
+ }
59
+
60
+ &[data-mode='secondary'] {
61
+ color: $sys-neutral-text-light;
62
+ }
63
+ }
@@ -0,0 +1,3 @@
1
+ export * from './CollapseBlockPrivate';
2
+ export * from './Separator';
3
+ export * from './HiddenTabButton';
package/src/index.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './components';
package/src/types.ts ADDED
@@ -0,0 +1,14 @@
1
+ import { RefObject } from 'react';
2
+
3
+ export type SearchState = {
4
+ placeholder?: string;
5
+ value?: string;
6
+ onChange(value: string): void;
7
+ loading?: boolean;
8
+ };
9
+
10
+ export type ScrollProps = {
11
+ scroll?: boolean;
12
+ scrollRef?: RefObject<HTMLElement>;
13
+ scrollContainerRef?: RefObject<HTMLElement>;
14
+ };
package/src/utils.ts ADDED
@@ -0,0 +1,106 @@
1
+ import { RefObject } from 'react';
2
+
3
+ import {
4
+ isAccordionItemProps,
5
+ isBaseItemProps,
6
+ isGroupItemProps,
7
+ isNextListItemProps,
8
+ ItemProps,
9
+ } from './components/Items';
10
+
11
+ type WithCollapsedItemsProps = {
12
+ items: ItemProps[];
13
+ openCollapsedItems: Array<number | string>;
14
+ };
15
+
16
+ export function withCollapsedItems({ items, openCollapsedItems }: WithCollapsedItemsProps) {
17
+ let itemRefs: RefObject<HTMLButtonElement>[] = [];
18
+ let newItems: ItemProps[] = [];
19
+ let ids: Array<string | number> = [];
20
+ let expandedIds: Array<string | number> = [];
21
+
22
+ items.forEach(item => {
23
+ if ((isBaseItemProps(item) || isNextListItemProps(item) || isAccordionItemProps(item)) && !item.disabled) {
24
+ newItems = newItems.concat([item]);
25
+ ids = ids.concat([item.id ?? '']);
26
+
27
+ if (item.itemRef) {
28
+ itemRefs = itemRefs.concat([item.itemRef]);
29
+ }
30
+ }
31
+
32
+ if (isNextListItemProps(item) && item.id && !item.disabled) {
33
+ expandedIds = expandedIds.concat(item.id);
34
+ }
35
+
36
+ if (isGroupItemProps(item)) {
37
+ const { itemRefs: nestedItemsRefs, ids: nestedIds } = withCollapsedItems({
38
+ items: item.items,
39
+ openCollapsedItems,
40
+ });
41
+
42
+ ids = ids.concat(nestedIds);
43
+
44
+ itemRefs = itemRefs.concat(nestedItemsRefs);
45
+ }
46
+
47
+ if (isAccordionItemProps(item) && item.id && openCollapsedItems.includes(item.id)) {
48
+ const {
49
+ itemRefs: nestedItemsRefs,
50
+ ids: nestedIds,
51
+ items: nestedItems,
52
+ expandedIds: nestedExpandedIds,
53
+ } = withCollapsedItems({
54
+ items: item.items,
55
+ openCollapsedItems,
56
+ });
57
+
58
+ ids = ids.concat(nestedIds);
59
+ newItems = newItems.concat(nestedItems);
60
+ itemRefs = itemRefs.concat(nestedItemsRefs);
61
+ expandedIds = expandedIds.concat(nestedExpandedIds);
62
+ }
63
+ });
64
+
65
+ return { items, itemRefs, ids, expandedIds };
66
+ }
67
+
68
+ export function extractItemRefs(items: ItemProps[]): RefObject<HTMLButtonElement>[] {
69
+ return items.reduce((prev: RefObject<HTMLButtonElement>[], item: ItemProps) => {
70
+ if (isGroupItemProps(item)) {
71
+ return prev.concat(extractItemRefs(item.items));
72
+ }
73
+ return item.itemRef ? prev.concat([item.itemRef]) : prev;
74
+ }, [] as RefObject<HTMLButtonElement>[]);
75
+ }
76
+
77
+ export function extractItemIds(items: ItemProps[]): Array<string | number> {
78
+ return items.reduce(
79
+ (prev: Array<string | number>, item: ItemProps) => {
80
+ if (isGroupItemProps(item)) {
81
+ return prev.concat(extractItemIds(item.items));
82
+ }
83
+ return item.id ? prev.concat([item.id]) : prev;
84
+ },
85
+ [] as Array<string | number>,
86
+ );
87
+ }
88
+
89
+ export function extractChildIds({ items }: { items: ItemProps[] }): Array<string | number> {
90
+ return items
91
+ .filter(item => isAccordionItemProps(item) || isNextListItemProps(item) || isGroupItemProps(item) || !item.disabled)
92
+ .reduce(
93
+ (prev: Array<string | number>, item: ItemProps) => {
94
+ if (isAccordionItemProps(item) || isNextListItemProps(item)) {
95
+ return prev.concat([item.id ?? '']).concat(extractChildIds({ items: item.items }));
96
+ }
97
+
98
+ if (isGroupItemProps(item)) {
99
+ return prev.concat(extractChildIds({ items: item.items }));
100
+ }
101
+
102
+ return item.id && !isGroupItemProps(item) ? prev.concat([item.id]) : prev;
103
+ },
104
+ [] as Array<string | number>,
105
+ );
106
+ }