@primer/components 31.0.2-rc.c7dafefb → 31.2.0-rc.2a086bac

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 (229) hide show
  1. package/.storybook/main.js +7 -9
  2. package/.storybook/preview.js +5 -1
  3. package/CHANGELOG.md +21 -1
  4. package/dist/browser.esm.js +623 -620
  5. package/dist/browser.esm.js.map +1 -1
  6. package/dist/browser.umd.js +164 -161
  7. package/dist/browser.umd.js.map +1 -1
  8. package/docs/content/ActionList2.mdx +354 -0
  9. package/docs/content/FilterList.md +2 -2
  10. package/docs/content/TextInputWithTokens.mdx +114 -0
  11. package/docs/content/theming.md +23 -0
  12. package/docs/src/@primer/gatsby-theme-doctocat/components/hero.js +1 -3
  13. package/docs/src/@primer/gatsby-theme-doctocat/components/live-preview-wrapper.js +1 -1
  14. package/docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js +17 -0
  15. package/lib/ActionList/Header.js +1 -1
  16. package/lib/ActionList2/Description.d.ts +12 -0
  17. package/lib/ActionList2/Description.js +53 -0
  18. package/lib/ActionList2/Divider.d.ts +5 -0
  19. package/lib/ActionList2/Divider.js +35 -0
  20. package/lib/ActionList2/Group.d.ts +11 -0
  21. package/lib/ActionList2/Group.js +57 -0
  22. package/lib/ActionList2/Header.d.ts +26 -0
  23. package/lib/ActionList2/Header.js +55 -0
  24. package/lib/ActionList2/Item.d.ts +63 -0
  25. package/lib/ActionList2/Item.js +234 -0
  26. package/lib/ActionList2/LinkItem.d.ts +17 -0
  27. package/lib/ActionList2/LinkItem.js +57 -0
  28. package/lib/ActionList2/List.d.ts +26 -0
  29. package/lib/ActionList2/List.js +59 -0
  30. package/lib/ActionList2/Selection.d.ts +5 -0
  31. package/lib/ActionList2/Selection.js +70 -0
  32. package/lib/ActionList2/Visuals.d.ts +9 -0
  33. package/lib/ActionList2/Visuals.js +90 -0
  34. package/lib/ActionList2/index.d.ts +36 -0
  35. package/lib/ActionList2/index.js +47 -0
  36. package/lib/Autocomplete/Autocomplete.d.ts +4 -4
  37. package/lib/Autocomplete/AutocompleteInput.d.ts +4 -4
  38. package/lib/Button/Button.d.ts +5 -5
  39. package/lib/Button/ButtonBase.d.ts +1 -1
  40. package/lib/Button/ButtonClose.d.ts +3 -3
  41. package/lib/Button/ButtonDanger.d.ts +5 -5
  42. package/lib/Button/ButtonInvisible.d.ts +5 -5
  43. package/lib/Button/ButtonOutline.d.ts +5 -5
  44. package/lib/Button/ButtonPrimary.d.ts +5 -5
  45. package/lib/CircleBadge.d.ts +2 -2
  46. package/lib/CircleOcticon.d.ts +4 -4
  47. package/lib/Dialog.d.ts +4 -4
  48. package/lib/Dropdown.d.ts +16 -16
  49. package/lib/DropdownMenu/DropdownButton.d.ts +6 -6
  50. package/lib/FilterList.d.ts +3 -3
  51. package/lib/Flash.d.ts +1 -1
  52. package/lib/Label.d.ts +1 -1
  53. package/lib/Overlay.js +3 -1
  54. package/lib/Portal/Portal.js +3 -2
  55. package/lib/Position.d.ts +4 -4
  56. package/lib/ProgressBar.d.ts +1 -1
  57. package/lib/SelectMenu/SelectMenu.d.ts +24 -24
  58. package/lib/SelectMenu/SelectMenuItem.d.ts +1 -1
  59. package/lib/TextInputWithTokens.d.ts +8 -4
  60. package/lib/TextInputWithTokens.js +61 -8
  61. package/lib/Timeline.d.ts +4 -4
  62. package/lib/Token/AvatarToken.d.ts +1 -1
  63. package/lib/Token/IssueLabelToken.d.ts +1 -1
  64. package/lib/Token/Token.d.ts +1 -1
  65. package/lib/_TextInputWrapper.d.ts +1 -1
  66. package/lib/_TextInputWrapper.js +2 -2
  67. package/lib/__tests__/ActionList2.test.d.ts +1 -0
  68. package/lib/__tests__/ActionList2.test.js +53 -0
  69. package/lib/__tests__/AnchoredOverlay.test.js +4 -2
  70. package/lib/__tests__/KeyPaths.types.test.d.ts +11 -0
  71. package/lib/__tests__/KeyPaths.types.test.js +10 -0
  72. package/lib/__tests__/TextInputWithTokens.test.js +138 -7
  73. package/lib/__tests__/utils/createSlots.test.d.ts +1 -0
  74. package/lib/__tests__/utils/createSlots.test.js +75 -0
  75. package/lib/hooks/useAnchoredPosition.js +3 -2
  76. package/lib/hooks/useCombinedRefs.d.ts +2 -2
  77. package/lib/hooks/useCombinedRefs.js +4 -6
  78. package/lib/hooks/useResizeObserver.js +2 -2
  79. package/lib/stories/ActionList2.stories.js +875 -0
  80. package/lib/stories/TextInput.stories.js +144 -0
  81. package/lib/stories/TextInputWithTokens.stories.js +18 -1
  82. package/lib/stories/Token.stories.js +19 -2
  83. package/lib/sx.d.ts +10 -2
  84. package/lib/sx.js +8 -0
  85. package/lib/theme-preval.js +81 -2
  86. package/lib/theme.d.ts +78 -0
  87. package/lib/theme.js +3 -1
  88. package/lib/unreleased.d.ts +7 -0
  89. package/lib/unreleased.js +18 -0
  90. package/lib/utils/create-slots.d.ts +17 -0
  91. package/lib/utils/create-slots.js +105 -0
  92. package/lib/utils/testing.d.ts +14 -1
  93. package/lib/utils/types/KeyPaths.d.ts +3 -0
  94. package/lib/utils/types/KeyPaths.js +1 -0
  95. package/lib/utils/use-force-update.d.ts +1 -0
  96. package/lib/utils/use-force-update.js +19 -0
  97. package/lib/utils/useIsomorphicLayoutEffect.d.ts +3 -0
  98. package/lib/utils/useIsomorphicLayoutEffect.js +12 -0
  99. package/lib-esm/ActionList/Header.js +1 -1
  100. package/lib-esm/ActionList2/Description.d.ts +12 -0
  101. package/lib-esm/ActionList2/Description.js +37 -0
  102. package/lib-esm/ActionList2/Divider.d.ts +5 -0
  103. package/lib-esm/ActionList2/Divider.js +23 -0
  104. package/lib-esm/ActionList2/Group.d.ts +11 -0
  105. package/lib-esm/ActionList2/Group.js +40 -0
  106. package/lib-esm/ActionList2/Header.d.ts +26 -0
  107. package/lib-esm/ActionList2/Header.js +44 -0
  108. package/lib-esm/ActionList2/Item.d.ts +63 -0
  109. package/lib-esm/ActionList2/Item.js +201 -0
  110. package/lib-esm/ActionList2/LinkItem.d.ts +17 -0
  111. package/lib-esm/ActionList2/LinkItem.js +43 -0
  112. package/lib-esm/ActionList2/List.d.ts +26 -0
  113. package/lib-esm/ActionList2/List.js +37 -0
  114. package/lib-esm/ActionList2/Selection.d.ts +5 -0
  115. package/lib-esm/ActionList2/Selection.js +52 -0
  116. package/lib-esm/ActionList2/Visuals.d.ts +9 -0
  117. package/lib-esm/ActionList2/Visuals.js +68 -0
  118. package/lib-esm/ActionList2/index.d.ts +36 -0
  119. package/lib-esm/ActionList2/index.js +33 -0
  120. package/lib-esm/Autocomplete/Autocomplete.d.ts +4 -4
  121. package/lib-esm/Autocomplete/AutocompleteInput.d.ts +4 -4
  122. package/lib-esm/Button/Button.d.ts +5 -5
  123. package/lib-esm/Button/ButtonBase.d.ts +1 -1
  124. package/lib-esm/Button/ButtonClose.d.ts +3 -3
  125. package/lib-esm/Button/ButtonDanger.d.ts +5 -5
  126. package/lib-esm/Button/ButtonInvisible.d.ts +5 -5
  127. package/lib-esm/Button/ButtonOutline.d.ts +5 -5
  128. package/lib-esm/Button/ButtonPrimary.d.ts +5 -5
  129. package/lib-esm/CircleBadge.d.ts +2 -2
  130. package/lib-esm/CircleOcticon.d.ts +4 -4
  131. package/lib-esm/Dialog.d.ts +4 -4
  132. package/lib-esm/Dropdown.d.ts +16 -16
  133. package/lib-esm/DropdownMenu/DropdownButton.d.ts +6 -6
  134. package/lib-esm/FilterList.d.ts +3 -3
  135. package/lib-esm/Flash.d.ts +1 -1
  136. package/lib-esm/Label.d.ts +1 -1
  137. package/lib-esm/Overlay.js +2 -1
  138. package/lib-esm/Portal/Portal.js +2 -1
  139. package/lib-esm/Position.d.ts +4 -4
  140. package/lib-esm/ProgressBar.d.ts +1 -1
  141. package/lib-esm/SelectMenu/SelectMenu.d.ts +24 -24
  142. package/lib-esm/SelectMenu/SelectMenuItem.d.ts +1 -1
  143. package/lib-esm/TextInputWithTokens.d.ts +8 -4
  144. package/lib-esm/TextInputWithTokens.js +60 -8
  145. package/lib-esm/Timeline.d.ts +4 -4
  146. package/lib-esm/Token/AvatarToken.d.ts +1 -1
  147. package/lib-esm/Token/IssueLabelToken.d.ts +1 -1
  148. package/lib-esm/Token/Token.d.ts +1 -1
  149. package/lib-esm/_TextInputWrapper.d.ts +1 -1
  150. package/lib-esm/_TextInputWrapper.js +2 -2
  151. package/lib-esm/__tests__/ActionList2.test.d.ts +1 -0
  152. package/lib-esm/__tests__/ActionList2.test.js +41 -0
  153. package/lib-esm/__tests__/AnchoredOverlay.test.js +4 -2
  154. package/lib-esm/__tests__/KeyPaths.types.test.d.ts +11 -0
  155. package/lib-esm/__tests__/KeyPaths.types.test.js +3 -0
  156. package/lib-esm/__tests__/TextInputWithTokens.test.js +132 -8
  157. package/lib-esm/__tests__/utils/createSlots.test.d.ts +1 -0
  158. package/lib-esm/__tests__/utils/createSlots.test.js +67 -0
  159. package/lib-esm/hooks/useAnchoredPosition.js +2 -1
  160. package/lib-esm/hooks/useCombinedRefs.d.ts +2 -2
  161. package/lib-esm/hooks/useCombinedRefs.js +3 -2
  162. package/lib-esm/hooks/useResizeObserver.js +2 -2
  163. package/lib-esm/stories/ActionList2.stories.js +764 -0
  164. package/lib-esm/stories/TextInput.stories.js +117 -0
  165. package/lib-esm/stories/TextInputWithTokens.stories.js +14 -0
  166. package/lib-esm/stories/Token.stories.js +14 -1
  167. package/lib-esm/sx.d.ts +10 -2
  168. package/lib-esm/sx.js +3 -1
  169. package/lib-esm/theme-preval.js +81 -2
  170. package/lib-esm/theme.d.ts +78 -0
  171. package/lib-esm/theme.js +2 -1
  172. package/lib-esm/unreleased.d.ts +7 -0
  173. package/lib-esm/unreleased.js +8 -0
  174. package/lib-esm/utils/create-slots.d.ts +17 -0
  175. package/lib-esm/utils/create-slots.js +84 -0
  176. package/lib-esm/utils/testing.d.ts +14 -1
  177. package/lib-esm/utils/types/KeyPaths.d.ts +3 -0
  178. package/lib-esm/utils/types/KeyPaths.js +1 -0
  179. package/lib-esm/utils/use-force-update.d.ts +1 -0
  180. package/lib-esm/utils/use-force-update.js +6 -0
  181. package/lib-esm/utils/useIsomorphicLayoutEffect.d.ts +3 -0
  182. package/lib-esm/utils/useIsomorphicLayoutEffect.js +3 -0
  183. package/migrating.md +1 -1
  184. package/package-lock.json +38098 -45
  185. package/package.json +7 -3
  186. package/script/build +2 -0
  187. package/src/ActionList/Header.tsx +1 -1
  188. package/src/ActionList2/Description.tsx +49 -0
  189. package/src/ActionList2/Divider.tsx +24 -0
  190. package/src/ActionList2/Group.tsx +34 -0
  191. package/src/ActionList2/Header.tsx +58 -0
  192. package/src/ActionList2/Item.tsx +228 -0
  193. package/src/ActionList2/LinkItem.tsx +49 -0
  194. package/src/ActionList2/List.tsx +55 -0
  195. package/src/ActionList2/Selection.tsx +40 -0
  196. package/src/ActionList2/Visuals.tsx +76 -0
  197. package/src/ActionList2/index.ts +39 -0
  198. package/src/Overlay.tsx +2 -1
  199. package/src/Portal/Portal.tsx +2 -1
  200. package/src/TextInputWithTokens.tsx +64 -8
  201. package/src/_TextInputWrapper.tsx +8 -0
  202. package/src/__tests__/ActionList2.test.tsx +47 -0
  203. package/src/__tests__/AnchoredOverlay.test.tsx +2 -2
  204. package/src/__tests__/KeyPaths.types.test.ts +14 -0
  205. package/src/__tests__/TextInputWithTokens.test.tsx +123 -1
  206. package/src/__tests__/__snapshots__/ActionList2.test.tsx.snap +14 -0
  207. package/src/__tests__/__snapshots__/AnchoredOverlay.test.tsx.snap +35 -135
  208. package/src/__tests__/__snapshots__/Autocomplete.test.tsx.snap +7 -0
  209. package/src/__tests__/__snapshots__/TextInput.test.tsx.snap +6 -0
  210. package/src/__tests__/__snapshots__/TextInputWithTokens.test.tsx.snap +463 -0
  211. package/src/__tests__/utils/__snapshots__/createSlots.test.tsx.snap +55 -0
  212. package/src/__tests__/utils/createSlots.test.tsx +74 -0
  213. package/src/hooks/useAnchoredPosition.ts +2 -1
  214. package/src/hooks/useCombinedRefs.ts +3 -3
  215. package/src/hooks/useResizeObserver.ts +2 -2
  216. package/src/stories/ActionList2.stories.tsx +1279 -0
  217. package/src/stories/Button.stories.tsx +1 -1
  218. package/src/stories/TextInput.stories.tsx +113 -0
  219. package/src/stories/TextInputWithTokens.stories.tsx +9 -0
  220. package/src/stories/Token.stories.tsx +12 -1
  221. package/src/sx.ts +17 -2
  222. package/src/theme-preval.js +1 -0
  223. package/src/theme.ts +86 -0
  224. package/src/unreleased.ts +9 -0
  225. package/src/utils/create-slots.tsx +96 -0
  226. package/src/utils/types/KeyPaths.ts +10 -0
  227. package/src/utils/use-force-update.ts +7 -0
  228. package/src/utils/useIsomorphicLayoutEffect.ts +10 -0
  229. package/stats.html +1 -1
@@ -0,0 +1,55 @@
1
+ // Jest Snapshot v1, https://goo.gl/fbAQLP
2
+
3
+ exports[`ComponentWithSlots renders all slots 1`] = `
4
+ <div>
5
+ <div>
6
+ first
7
+ <span>
8
+ free form
9
+
10
+ second
11
+
12
+ </span>
13
+ </div>
14
+ </div>
15
+ `;
16
+
17
+ exports[`ComponentWithSlots renders with context passed to children 1`] = `
18
+ <div>
19
+ <div>
20
+ <span>
21
+ free form
22
+
23
+
24
+ hi
25
+
26
+ third
27
+ </span>
28
+ </div>
29
+ </div>
30
+ `;
31
+
32
+ exports[`ComponentWithSlots renders with just one slot 1`] = `
33
+ <div>
34
+ <div>
35
+ first
36
+ <span>
37
+ free form
38
+
39
+
40
+ </span>
41
+ </div>
42
+ </div>
43
+ `;
44
+
45
+ exports[`ComponentWithSlots renders without any slots 1`] = `
46
+ <div>
47
+ <div>
48
+ <span>
49
+ free form
50
+
51
+
52
+ </span>
53
+ </div>
54
+ </div>
55
+ `;
@@ -0,0 +1,74 @@
1
+ import React from 'react'
2
+ import 'babel-polyfill'
3
+ import {render, waitFor} from '@testing-library/react'
4
+ import createSlots from '../../utils/create-slots'
5
+
6
+ // setup a component with slots
7
+ const {Slots, Slot} = createSlots(['One', 'Two', 'Three'])
8
+ type ContextTypes = {salutation?: string}
9
+
10
+ const ComponentWithSlots: React.FC<ContextTypes> = ({salutation, children}) => {
11
+ return (
12
+ <Slots context={{salutation}}>
13
+ {slots => (
14
+ <div>
15
+ {slots.One}
16
+ <span>
17
+ {children} {slots.Two} {slots.Three}
18
+ </span>
19
+ </div>
20
+ )}
21
+ </Slots>
22
+ )
23
+ }
24
+ const SlotItem1: React.FC = ({children}) => <Slot name="One">{children}</Slot>
25
+ const SlotItem2: React.FC = ({children}) => <Slot name="Two">{children}</Slot>
26
+ const SlotItem3: React.FC = ({children}) => (
27
+ <Slot name="Three">
28
+ {(context: ContextTypes) => (
29
+ <>
30
+ {context.salutation} {children}
31
+ </>
32
+ )}
33
+ </Slot>
34
+ )
35
+
36
+ describe('ComponentWithSlots', () => {
37
+ it('renders all slots', async () => {
38
+ const component = render(
39
+ <ComponentWithSlots>
40
+ <SlotItem1>first</SlotItem1>
41
+ <SlotItem2>second</SlotItem2>
42
+ free form
43
+ </ComponentWithSlots>
44
+ )
45
+
46
+ await waitFor(() => component.getByText('first'))
47
+ expect(component.container).toMatchSnapshot()
48
+ })
49
+
50
+ it('renders without any slots', async () => {
51
+ const component = render(<ComponentWithSlots>free form</ComponentWithSlots>)
52
+ expect(component.container).toMatchSnapshot()
53
+ })
54
+
55
+ it('renders with just one slot', async () => {
56
+ const component = render(
57
+ <ComponentWithSlots>
58
+ <SlotItem1>first</SlotItem1>
59
+ free form
60
+ </ComponentWithSlots>
61
+ )
62
+ expect(component.container).toMatchSnapshot()
63
+ })
64
+
65
+ it('renders with context passed to children', async () => {
66
+ const component = render(
67
+ <ComponentWithSlots salutation="hi">
68
+ <SlotItem3>third</SlotItem3>
69
+ free form
70
+ </ComponentWithSlots>
71
+ )
72
+ expect(component.container).toMatchSnapshot()
73
+ })
74
+ })
@@ -2,6 +2,7 @@ import React from 'react'
2
2
  import {PositionSettings, getAnchoredPosition, AnchorPosition} from '../behaviors/anchoredPosition'
3
3
  import {useProvidedRefOrCreate} from './useProvidedRefOrCreate'
4
4
  import {useResizeObserver} from './useResizeObserver'
5
+ import useLayoutEffect from '../utils/useIsomorphicLayoutEffect'
5
6
 
6
7
  export interface AnchoredPositionHookSettings extends Partial<PositionSettings> {
7
8
  floatingElementRef?: React.RefObject<Element>
@@ -41,7 +42,7 @@ export function useAnchoredPosition(
41
42
  [floatingElementRef, anchorElementRef, ...dependencies]
42
43
  )
43
44
 
44
- React.useLayoutEffect(updatePosition, [updatePosition])
45
+ useLayoutEffect(updatePosition, [updatePosition])
45
46
 
46
47
  useResizeObserver(updatePosition)
47
48
 
@@ -1,4 +1,5 @@
1
- import React, {ForwardedRef, useRef} from 'react'
1
+ import {ForwardedRef, useRef} from 'react'
2
+ import useLayoutEffect from '../utils/useIsomorphicLayoutEffect'
2
3
 
3
4
  /**
4
5
  * Creates a ref by combining multiple constituent refs. The ref returned by this hook
@@ -11,7 +12,7 @@ import React, {ForwardedRef, useRef} from 'react'
11
12
  export function useCombinedRefs<T>(...refs: (ForwardedRef<T> | null | undefined)[]) {
12
13
  const combinedRef = useRef<T | null>(null)
13
14
 
14
- React.useLayoutEffect(() => {
15
+ useLayoutEffect(() => {
15
16
  function setRefs(current: T | null = null) {
16
17
  for (const ref of refs) {
17
18
  if (!ref) {
@@ -32,7 +33,6 @@ export function useCombinedRefs<T>(...refs: (ForwardedRef<T> | null | undefined)
32
33
  // eslint-disable-next-line react-hooks/exhaustive-deps
33
34
  setRefs(combinedRef.current)
34
35
  }
35
-
36
36
  // eslint-disable-next-line react-hooks/exhaustive-deps
37
37
  }, [...refs, combinedRef.current])
38
38
 
@@ -1,7 +1,7 @@
1
- import React from 'react'
1
+ import useLayoutEffect from '../utils/useIsomorphicLayoutEffect'
2
2
 
3
3
  export function useResizeObserver(callback: () => void) {
4
- React.useLayoutEffect(() => {
4
+ useLayoutEffect(() => {
5
5
  const observer = new window.ResizeObserver(() => callback())
6
6
  observer.observe(document.documentElement)
7
7
  return () => {