@primer/components 31.0.0 → 31.0.2-rc.c7dafefb

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 (817) hide show
  1. package/.changeset/README.md +8 -0
  2. package/.changeset/config.json +10 -0
  3. package/.devcontainer/devcontainer.json +8 -0
  4. package/.eslintrc.json +137 -0
  5. package/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
  6. package/.github/ISSUE_TEMPLATE/new_component_proposal_template.md +41 -0
  7. package/.github/dependabot.yml +18 -0
  8. package/.github/pull_request_template.md +18 -0
  9. package/.github/workflows/check_for_changeset.yml +25 -0
  10. package/.github/workflows/ci.yml +31 -0
  11. package/.github/workflows/deploy_preview.yml +47 -0
  12. package/.github/workflows/deploy_production.yml +70 -0
  13. package/.github/workflows/release.yml +35 -0
  14. package/.github/workflows/release_canary.yml +70 -0
  15. package/.github/workflows/release_candidate.yml +60 -0
  16. package/.github/workflows/size.yml +13 -0
  17. package/.github/workflows/stale.yml +26 -0
  18. package/.gitignore +10 -0
  19. package/.npmrc +4 -0
  20. package/.nvmrc +1 -0
  21. package/.storybook/main.js +11 -0
  22. package/.storybook/preview.js +113 -0
  23. package/.vscode/launch.json +21 -0
  24. package/.vscode/settings.json +13 -0
  25. package/@types/@styled-system/index.d.ts +0 -0
  26. package/@types/@styled-system/prop-types/index.d.ts +1 -0
  27. package/@types/@styled-system/props/index.d.ts +1 -0
  28. package/@types/jest-styled-components/index.d.ts +1 -0
  29. package/CHANGELOG.md +14 -0
  30. package/CODEOWNERS +2 -0
  31. package/babel-defines.js +13 -0
  32. package/babel.config.js +39 -0
  33. package/contributor-docs/CODE_OF_CONDUCT.md +76 -0
  34. package/contributor-docs/CONTRIBUTING.md +274 -0
  35. package/contributor-docs/adrs/adr-001-typescript.md +23 -0
  36. package/contributor-docs/adrs/adr-002-behavior-isolation.md +108 -0
  37. package/contributor-docs/adrs/adr-003-prop-norms.md +72 -0
  38. package/contributor-docs/behaviors.md +132 -0
  39. package/contributor-docs/component-contents-api-patterns.md +316 -0
  40. package/contributor-docs/principles.md +39 -0
  41. package/dist/browser.esm.js +46 -43
  42. package/dist/browser.esm.js.map +1 -1
  43. package/dist/browser.umd.js +45 -42
  44. package/dist/browser.umd.js.map +1 -1
  45. package/docs/.eslintrc +0 -0
  46. package/docs/.gitignore +91 -0
  47. package/docs/components/PropsList.js +5 -0
  48. package/docs/components/State.js +9 -0
  49. package/docs/components/constants.js +34 -0
  50. package/docs/components/index.js +2 -0
  51. package/docs/content/ActionList.mdx +99 -0
  52. package/docs/content/ActionMenu.mdx +80 -0
  53. package/docs/content/AnchoredOverlay.mdx +37 -0
  54. package/docs/content/Autocomplete.mdx +657 -0
  55. package/docs/content/Avatar.mdx +33 -0
  56. package/docs/content/AvatarStack.mdx +37 -0
  57. package/docs/content/BorderBox.md +46 -0
  58. package/docs/content/Box.md +74 -0
  59. package/docs/content/BranchName.md +18 -0
  60. package/docs/content/Breadcrumbs.md +52 -0
  61. package/docs/content/Buttons.md +56 -0
  62. package/docs/content/CircleBadge.md +45 -0
  63. package/docs/content/CircleOcticon.md +18 -0
  64. package/docs/content/CounterLabel.md +32 -0
  65. package/docs/content/Details.md +105 -0
  66. package/docs/content/Dialog.md +108 -0
  67. package/docs/content/Dialog2.mdx +179 -0
  68. package/docs/content/Dropdown.md +72 -0
  69. package/docs/content/DropdownMenu.mdx +49 -0
  70. package/docs/content/FilterList.md +44 -0
  71. package/docs/content/FilteredSearch.md +39 -0
  72. package/docs/content/Flash.md +44 -0
  73. package/docs/content/Flex.md +58 -0
  74. package/docs/content/FormGroup.md +46 -0
  75. package/docs/content/Grid.md +59 -0
  76. package/docs/content/Header.md +79 -0
  77. package/docs/content/Heading.md +22 -0
  78. package/docs/content/Label.md +42 -0
  79. package/docs/content/LabelGroup.md +31 -0
  80. package/docs/content/Link.md +37 -0
  81. package/docs/content/Overlay.mdx +94 -0
  82. package/docs/content/Pagehead.md +27 -0
  83. package/docs/content/Pagination.md +187 -0
  84. package/docs/content/PointerBox.md +81 -0
  85. package/docs/content/Popover.md +137 -0
  86. package/docs/content/Portal.mdx +78 -0
  87. package/docs/content/Position.md +100 -0
  88. package/docs/content/ProgressBar.mdx +29 -0
  89. package/docs/content/SelectMenu.md +435 -0
  90. package/docs/content/SelectPanel.mdx +67 -0
  91. package/docs/content/SideNav.md +179 -0
  92. package/docs/content/Spinner.mdx +32 -0
  93. package/docs/content/StateLabel.md +35 -0
  94. package/docs/content/StyledOcticon.md +36 -0
  95. package/docs/content/SubNav.md +102 -0
  96. package/docs/content/TabNav.md +50 -0
  97. package/docs/content/Text.md +31 -0
  98. package/docs/content/TextInput.md +34 -0
  99. package/docs/content/TextInputTokens.mdx +89 -0
  100. package/docs/content/TextInputWithTokens.mdx +97 -0
  101. package/docs/content/Timeline.md +138 -0
  102. package/docs/content/Token.mdx +381 -0
  103. package/docs/content/Tooltip.md +41 -0
  104. package/docs/content/Truncate.md +64 -0
  105. package/docs/content/UnderlineNav.md +53 -0
  106. package/docs/content/anchoredPosition.mdx +163 -0
  107. package/docs/content/core-concepts.md +70 -0
  108. package/docs/content/focusTrap.mdx +103 -0
  109. package/docs/content/focusZone.mdx +145 -0
  110. package/docs/content/getting-started.md +138 -0
  111. package/docs/content/index.md +33 -0
  112. package/docs/content/linting.md +35 -0
  113. package/docs/content/overriding-styles.mdx +82 -0
  114. package/docs/content/philosophy.md +23 -0
  115. package/docs/content/primer-theme.md +89 -0
  116. package/docs/content/ssr.mdx +43 -0
  117. package/docs/content/system-props.mdx +37 -0
  118. package/docs/content/theme-reference.md +16 -0
  119. package/docs/content/theming.md +249 -0
  120. package/docs/content/useOnEscapePress.mdx +56 -0
  121. package/docs/content/useOnOutsideClick.mdx +57 -0
  122. package/docs/content/useOpenAndCloseFocus.mdx +49 -0
  123. package/docs/content/useOverlay.mdx +62 -0
  124. package/docs/content/useSafeTimeout.mdx +32 -0
  125. package/docs/gatsby-config.js +30 -0
  126. package/docs/gatsby-node.js +101 -0
  127. package/docs/package-lock.json +20756 -0
  128. package/docs/package.json +36 -0
  129. package/docs/src/@primer/gatsby-theme-doctocat/components/hero.js +23 -0
  130. package/docs/src/@primer/gatsby-theme-doctocat/components/live-preview-wrapper.js +41 -0
  131. package/docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js +56 -0
  132. package/docs/src/@primer/gatsby-theme-doctocat/nav.yml +133 -0
  133. package/docs/src/@primer/gatsby-theme-doctocat/primer-components-hero.svg +1411 -0
  134. package/docs/src/props.js +77 -0
  135. package/jest.config.js +13 -0
  136. package/lib/ActionList/Item.d.ts +6 -0
  137. package/lib/ActionList/Item.js +5 -1
  138. package/lib/TextInputWithTokens.js +42 -22
  139. package/lib/Token/Token.js +13 -2
  140. package/lib/Token/TokenBase.js +0 -4
  141. package/lib/Token/_RemoveTokenButton.js +15 -2
  142. package/lib/__tests__/ActionList.test.d.ts +1 -0
  143. package/lib/__tests__/ActionList.test.js +69 -0
  144. package/lib/__tests__/ActionList.types.test.d.ts +6 -0
  145. package/lib/__tests__/ActionList.types.test.js +69 -0
  146. package/lib/__tests__/ActionMenu.test.d.ts +1 -0
  147. package/lib/__tests__/ActionMenu.test.js +151 -0
  148. package/lib/__tests__/AnchoredOverlay.test.d.ts +1 -0
  149. package/lib/__tests__/AnchoredOverlay.test.js +160 -0
  150. package/lib/__tests__/Autocomplete.test.d.ts +1 -0
  151. package/lib/__tests__/Autocomplete.test.js +528 -0
  152. package/lib/__tests__/Avatar.test.d.ts +1 -0
  153. package/lib/__tests__/Avatar.test.js +67 -0
  154. package/lib/__tests__/AvatarStack.test.d.ts +1 -0
  155. package/lib/__tests__/AvatarStack.test.js +71 -0
  156. package/lib/__tests__/BorderBox.test.d.ts +1 -0
  157. package/lib/__tests__/BorderBox.test.js +58 -0
  158. package/lib/__tests__/Box.test.d.ts +1 -0
  159. package/lib/__tests__/Box.test.js +78 -0
  160. package/lib/__tests__/BranchName.test.d.ts +1 -0
  161. package/lib/__tests__/BranchName.test.js +36 -0
  162. package/lib/__tests__/Breadcrumbs.test.d.ts +1 -0
  163. package/lib/__tests__/Breadcrumbs.test.js +37 -0
  164. package/lib/__tests__/BreadcrumbsItem.test.d.ts +1 -0
  165. package/lib/__tests__/BreadcrumbsItem.test.js +49 -0
  166. package/lib/__tests__/Button.test.d.ts +1 -0
  167. package/lib/__tests__/Button.test.js +143 -0
  168. package/lib/__tests__/Caret.test.d.ts +1 -0
  169. package/lib/__tests__/Caret.test.js +52 -0
  170. package/lib/__tests__/CircleBadge.test.d.ts +1 -0
  171. package/lib/__tests__/CircleBadge.test.js +83 -0
  172. package/lib/__tests__/CircleOcticon.test.d.ts +1 -0
  173. package/lib/__tests__/CircleOcticon.test.js +71 -0
  174. package/lib/__tests__/ConfirmationDialog.test.d.ts +1 -0
  175. package/lib/__tests__/ConfirmationDialog.test.js +134 -0
  176. package/lib/__tests__/CounterLabel.test.d.ts +1 -0
  177. package/lib/__tests__/CounterLabel.test.js +58 -0
  178. package/lib/__tests__/Details.test.d.ts +1 -0
  179. package/lib/__tests__/Details.test.js +117 -0
  180. package/lib/__tests__/Dialog.test.d.ts +1 -0
  181. package/lib/__tests__/Dialog.test.js +184 -0
  182. package/lib/__tests__/Dropdown.test.d.ts +1 -0
  183. package/lib/__tests__/Dropdown.test.js +63 -0
  184. package/lib/__tests__/DropdownMenu.test.d.ts +1 -0
  185. package/lib/__tests__/DropdownMenu.test.js +150 -0
  186. package/lib/__tests__/FilterList.test.d.ts +1 -0
  187. package/lib/__tests__/FilterList.test.js +36 -0
  188. package/lib/__tests__/FilterListItem.test.d.ts +1 -0
  189. package/lib/__tests__/FilterListItem.test.js +46 -0
  190. package/lib/__tests__/FilteredSearch.test.d.ts +1 -0
  191. package/lib/__tests__/FilteredSearch.test.js +36 -0
  192. package/lib/__tests__/Flash.test.d.ts +1 -0
  193. package/lib/__tests__/Flash.test.js +62 -0
  194. package/lib/__tests__/Flex.test.d.ts +1 -0
  195. package/lib/__tests__/Flex.test.js +74 -0
  196. package/lib/__tests__/FormGroup.test.d.ts +1 -0
  197. package/lib/__tests__/FormGroup.test.js +54 -0
  198. package/lib/__tests__/Grid.test.d.ts +1 -0
  199. package/lib/__tests__/Grid.test.js +104 -0
  200. package/lib/__tests__/Header.test.d.ts +1 -0
  201. package/lib/__tests__/Header.test.js +58 -0
  202. package/lib/__tests__/Heading.test.d.ts +1 -0
  203. package/lib/__tests__/Heading.test.js +109 -0
  204. package/lib/__tests__/Label.test.d.ts +1 -0
  205. package/lib/__tests__/Label.test.js +46 -0
  206. package/lib/__tests__/LabelGroup.test.d.ts +1 -0
  207. package/lib/__tests__/LabelGroup.test.js +38 -0
  208. package/lib/__tests__/Link.test.d.ts +1 -0
  209. package/lib/__tests__/Link.test.js +70 -0
  210. package/lib/__tests__/Merge.types.test.d.ts +30 -0
  211. package/lib/__tests__/Merge.types.test.js +27 -0
  212. package/lib/__tests__/Overlay.test.d.ts +1 -0
  213. package/lib/__tests__/Overlay.test.js +145 -0
  214. package/lib/__tests__/Pagehead.test.d.ts +1 -0
  215. package/lib/__tests__/Pagehead.test.js +37 -0
  216. package/lib/__tests__/Pagination/Pagination.test.d.ts +1 -0
  217. package/lib/__tests__/Pagination/Pagination.test.js +47 -0
  218. package/lib/__tests__/Pagination/PaginationModel.test.d.ts +1 -0
  219. package/lib/__tests__/Pagination/PaginationModel.test.js +186 -0
  220. package/lib/__tests__/PointerBox.test.d.ts +1 -0
  221. package/lib/__tests__/PointerBox.test.js +46 -0
  222. package/lib/__tests__/Popover.test.d.ts +1 -0
  223. package/lib/__tests__/Popover.test.js +66 -0
  224. package/lib/__tests__/Portal.test.d.ts +1 -0
  225. package/lib/__tests__/Portal.test.js +124 -0
  226. package/lib/__tests__/Position.test.d.ts +1 -0
  227. package/lib/__tests__/Position.test.js +143 -0
  228. package/lib/__tests__/ProgressBar.test.d.ts +1 -0
  229. package/lib/__tests__/ProgressBar.test.js +68 -0
  230. package/lib/__tests__/SelectMenu.test.d.ts +1 -0
  231. package/lib/__tests__/SelectMenu.test.js +155 -0
  232. package/lib/__tests__/SelectPanel.test.d.ts +1 -0
  233. package/lib/__tests__/SelectPanel.test.js +80 -0
  234. package/lib/__tests__/SideNav.test.d.ts +1 -0
  235. package/lib/__tests__/SideNav.test.js +71 -0
  236. package/lib/__tests__/Spinner.test.d.ts +1 -0
  237. package/lib/__tests__/Spinner.test.js +53 -0
  238. package/lib/__tests__/StateLabel.test.d.ts +1 -0
  239. package/lib/__tests__/StateLabel.test.js +71 -0
  240. package/lib/__tests__/StyledOcticon.test.d.ts +1 -0
  241. package/lib/__tests__/StyledOcticon.test.js +40 -0
  242. package/lib/__tests__/SubNav.test.d.ts +1 -0
  243. package/lib/__tests__/SubNav.test.js +62 -0
  244. package/lib/__tests__/SubNavLink.test.d.ts +1 -0
  245. package/lib/__tests__/SubNavLink.test.js +49 -0
  246. package/lib/__tests__/TabNav.test.d.ts +1 -0
  247. package/lib/__tests__/TabNav.test.js +49 -0
  248. package/lib/__tests__/Text.test.d.ts +1 -0
  249. package/lib/__tests__/Text.test.js +105 -0
  250. package/lib/__tests__/TextInput.test.d.ts +1 -0
  251. package/lib/__tests__/TextInput.test.js +78 -0
  252. package/lib/__tests__/TextInputWithTokens.test.d.ts +1 -0
  253. package/lib/__tests__/TextInputWithTokens.test.js +441 -0
  254. package/lib/__tests__/ThemeProvider.test.d.ts +1 -0
  255. package/lib/__tests__/ThemeProvider.test.js +444 -0
  256. package/lib/__tests__/Timeline.test.d.ts +1 -0
  257. package/lib/__tests__/Timeline.test.js +75 -0
  258. package/lib/__tests__/Token.test.d.ts +1 -0
  259. package/lib/__tests__/Token.test.js +180 -0
  260. package/lib/__tests__/Tooltip.test.d.ts +1 -0
  261. package/lib/__tests__/Tooltip.test.js +69 -0
  262. package/lib/__tests__/Truncate.test.d.ts +1 -0
  263. package/lib/__tests__/Truncate.test.js +63 -0
  264. package/lib/__tests__/UnderlineNav.test.d.ts +1 -0
  265. package/lib/__tests__/UnderlineNav.test.js +72 -0
  266. package/lib/__tests__/UnderlineNavLink.test.d.ts +1 -0
  267. package/lib/__tests__/UnderlineNavLink.test.js +51 -0
  268. package/lib/__tests__/behaviors/anchoredPosition.test.d.ts +1 -0
  269. package/lib/__tests__/behaviors/anchoredPosition.test.js +390 -0
  270. package/lib/__tests__/behaviors/focusTrap.test.d.ts +1 -0
  271. package/lib/__tests__/behaviors/focusTrap.test.js +234 -0
  272. package/lib/__tests__/behaviors/focusZone.test.d.ts +1 -0
  273. package/lib/__tests__/behaviors/focusZone.test.js +570 -0
  274. package/lib/__tests__/behaviors/iterateFocusableElements.test.d.ts +1 -0
  275. package/lib/__tests__/behaviors/iterateFocusableElements.test.js +55 -0
  276. package/lib/__tests__/behaviors/scrollIntoViewingArea.test.d.ts +1 -0
  277. package/lib/__tests__/behaviors/scrollIntoViewingArea.test.js +226 -0
  278. package/lib/__tests__/filterObject.test.d.ts +1 -0
  279. package/lib/__tests__/filterObject.test.js +30 -0
  280. package/lib/__tests__/hooks/useAnchoredPosition.test.d.ts +1 -0
  281. package/lib/__tests__/hooks/useAnchoredPosition.test.js +54 -0
  282. package/lib/__tests__/hooks/useOnEscapePress.test.d.ts +1 -0
  283. package/lib/__tests__/hooks/useOnEscapePress.test.js +32 -0
  284. package/lib/__tests__/hooks/useOnOutsideClick.test.d.ts +1 -0
  285. package/lib/__tests__/hooks/useOnOutsideClick.test.js +87 -0
  286. package/lib/__tests__/hooks/useOpenAndCloseFocus.test.d.ts +1 -0
  287. package/lib/__tests__/hooks/useOpenAndCloseFocus.test.js +60 -0
  288. package/lib/__tests__/hooks/useProvidedStateOrCreate.test.d.ts +1 -0
  289. package/lib/__tests__/hooks/useProvidedStateOrCreate.test.js +45 -0
  290. package/lib/__tests__/theme.test.d.ts +1 -0
  291. package/lib/__tests__/theme.test.js +36 -0
  292. package/lib/__tests__/themeGet.test.d.ts +1 -0
  293. package/lib/__tests__/themeGet.test.js +25 -0
  294. package/lib/__tests__/useSafeTimeout.test.d.ts +1 -0
  295. package/lib/__tests__/useSafeTimeout.test.js +45 -0
  296. package/lib/stories/ActionList.stories.js +454 -0
  297. package/lib/stories/ActionMenu.stories.js +350 -0
  298. package/lib/stories/AnchoredOverlay.stories.js +127 -0
  299. package/lib/stories/Autocomplete.stories.js +619 -0
  300. package/lib/stories/AvatarStack.stories.js +49 -0
  301. package/lib/stories/Button.stories.js +125 -0
  302. package/lib/stories/ConfirmationDialog.stories.js +111 -0
  303. package/lib/stories/Dialog.stories.js +265 -0
  304. package/lib/stories/DropdownMenu.stories.js +122 -0
  305. package/lib/stories/IssueLabelToken.stories.js +165 -0
  306. package/lib/stories/Overlay.stories.js +204 -0
  307. package/lib/stories/Portal.stories.js +104 -0
  308. package/lib/stories/ProfileToken.stories.js +162 -0
  309. package/lib/stories/SelectPanel.stories.js +399 -0
  310. package/lib/stories/TextInputWithTokens.stories.js +235 -0
  311. package/lib/stories/ThemeProvider.stories.js +102 -0
  312. package/lib/stories/Token.stories.js +159 -0
  313. package/lib/stories/useAnchoredPosition.stories.js +351 -0
  314. package/lib/stories/useFocusTrap.stories.js +356 -0
  315. package/lib/stories/useFocusZone.stories.js +599 -0
  316. package/lib-esm/ActionList/Item.d.ts +6 -0
  317. package/lib-esm/ActionList/Item.js +5 -1
  318. package/lib-esm/TextInputWithTokens.js +42 -23
  319. package/lib-esm/Token/Token.js +13 -2
  320. package/lib-esm/Token/TokenBase.js +0 -4
  321. package/lib-esm/Token/_RemoveTokenButton.js +11 -2
  322. package/lib-esm/__tests__/ActionList.test.d.ts +1 -0
  323. package/lib-esm/__tests__/ActionList.test.js +57 -0
  324. package/lib-esm/__tests__/ActionList.types.test.d.ts +6 -0
  325. package/lib-esm/__tests__/ActionList.types.test.js +45 -0
  326. package/lib-esm/__tests__/ActionMenu.test.d.ts +1 -0
  327. package/lib-esm/__tests__/ActionMenu.test.js +139 -0
  328. package/lib-esm/__tests__/AnchoredOverlay.test.d.ts +1 -0
  329. package/lib-esm/__tests__/AnchoredOverlay.test.js +134 -0
  330. package/lib-esm/__tests__/Autocomplete.test.d.ts +1 -0
  331. package/lib-esm/__tests__/Autocomplete.test.js +494 -0
  332. package/lib-esm/__tests__/Avatar.test.d.ts +1 -0
  333. package/lib-esm/__tests__/Avatar.test.js +56 -0
  334. package/lib-esm/__tests__/AvatarStack.test.d.ts +1 -0
  335. package/lib-esm/__tests__/AvatarStack.test.js +58 -0
  336. package/lib-esm/__tests__/BorderBox.test.d.ts +1 -0
  337. package/lib-esm/__tests__/BorderBox.test.js +47 -0
  338. package/lib-esm/__tests__/Box.test.d.ts +1 -0
  339. package/lib-esm/__tests__/Box.test.js +67 -0
  340. package/lib-esm/__tests__/BranchName.test.d.ts +1 -0
  341. package/lib-esm/__tests__/BranchName.test.js +26 -0
  342. package/lib-esm/__tests__/Breadcrumbs.test.d.ts +1 -0
  343. package/lib-esm/__tests__/Breadcrumbs.test.js +27 -0
  344. package/lib-esm/__tests__/BreadcrumbsItem.test.d.ts +1 -0
  345. package/lib-esm/__tests__/BreadcrumbsItem.test.js +39 -0
  346. package/lib-esm/__tests__/Button.test.d.ts +1 -0
  347. package/lib-esm/__tests__/Button.test.js +133 -0
  348. package/lib-esm/__tests__/Caret.test.d.ts +1 -0
  349. package/lib-esm/__tests__/Caret.test.js +42 -0
  350. package/lib-esm/__tests__/CircleBadge.test.d.ts +1 -0
  351. package/lib-esm/__tests__/CircleBadge.test.js +70 -0
  352. package/lib-esm/__tests__/CircleOcticon.test.d.ts +1 -0
  353. package/lib-esm/__tests__/CircleOcticon.test.js +59 -0
  354. package/lib-esm/__tests__/ConfirmationDialog.test.d.ts +1 -0
  355. package/lib-esm/__tests__/ConfirmationDialog.test.js +113 -0
  356. package/lib-esm/__tests__/CounterLabel.test.d.ts +1 -0
  357. package/lib-esm/__tests__/CounterLabel.test.js +47 -0
  358. package/lib-esm/__tests__/Details.test.d.ts +1 -0
  359. package/lib-esm/__tests__/Details.test.js +107 -0
  360. package/lib-esm/__tests__/Dialog.test.d.ts +1 -0
  361. package/lib-esm/__tests__/Dialog.test.js +171 -0
  362. package/lib-esm/__tests__/Dropdown.test.d.ts +1 -0
  363. package/lib-esm/__tests__/Dropdown.test.js +53 -0
  364. package/lib-esm/__tests__/DropdownMenu.test.d.ts +1 -0
  365. package/lib-esm/__tests__/DropdownMenu.test.js +137 -0
  366. package/lib-esm/__tests__/FilterList.test.d.ts +1 -0
  367. package/lib-esm/__tests__/FilterList.test.js +26 -0
  368. package/lib-esm/__tests__/FilterListItem.test.d.ts +1 -0
  369. package/lib-esm/__tests__/FilterListItem.test.js +36 -0
  370. package/lib-esm/__tests__/FilteredSearch.test.d.ts +1 -0
  371. package/lib-esm/__tests__/FilteredSearch.test.js +26 -0
  372. package/lib-esm/__tests__/Flash.test.d.ts +1 -0
  373. package/lib-esm/__tests__/Flash.test.js +51 -0
  374. package/lib-esm/__tests__/Flex.test.d.ts +1 -0
  375. package/lib-esm/__tests__/Flex.test.js +64 -0
  376. package/lib-esm/__tests__/FormGroup.test.d.ts +1 -0
  377. package/lib-esm/__tests__/FormGroup.test.js +44 -0
  378. package/lib-esm/__tests__/Grid.test.d.ts +1 -0
  379. package/lib-esm/__tests__/Grid.test.js +94 -0
  380. package/lib-esm/__tests__/Header.test.d.ts +1 -0
  381. package/lib-esm/__tests__/Header.test.js +48 -0
  382. package/lib-esm/__tests__/Heading.test.d.ts +1 -0
  383. package/lib-esm/__tests__/Heading.test.js +99 -0
  384. package/lib-esm/__tests__/Label.test.d.ts +1 -0
  385. package/lib-esm/__tests__/Label.test.js +36 -0
  386. package/lib-esm/__tests__/LabelGroup.test.d.ts +1 -0
  387. package/lib-esm/__tests__/LabelGroup.test.js +26 -0
  388. package/lib-esm/__tests__/Link.test.d.ts +1 -0
  389. package/lib-esm/__tests__/Link.test.js +60 -0
  390. package/lib-esm/__tests__/Merge.types.test.d.ts +30 -0
  391. package/lib-esm/__tests__/Merge.types.test.js +14 -0
  392. package/lib-esm/__tests__/Overlay.test.d.ts +1 -0
  393. package/lib-esm/__tests__/Overlay.test.js +123 -0
  394. package/lib-esm/__tests__/Pagehead.test.d.ts +1 -0
  395. package/lib-esm/__tests__/Pagehead.test.js +26 -0
  396. package/lib-esm/__tests__/Pagination/Pagination.test.d.ts +1 -0
  397. package/lib-esm/__tests__/Pagination/Pagination.test.js +35 -0
  398. package/lib-esm/__tests__/Pagination/PaginationModel.test.d.ts +1 -0
  399. package/lib-esm/__tests__/Pagination/PaginationModel.test.js +182 -0
  400. package/lib-esm/__tests__/PointerBox.test.d.ts +1 -0
  401. package/lib-esm/__tests__/PointerBox.test.js +36 -0
  402. package/lib-esm/__tests__/Popover.test.d.ts +1 -0
  403. package/lib-esm/__tests__/Popover.test.js +53 -0
  404. package/lib-esm/__tests__/Portal.test.d.ts +1 -0
  405. package/lib-esm/__tests__/Portal.test.js +104 -0
  406. package/lib-esm/__tests__/Position.test.d.ts +1 -0
  407. package/lib-esm/__tests__/Position.test.js +133 -0
  408. package/lib-esm/__tests__/ProgressBar.test.d.ts +1 -0
  409. package/lib-esm/__tests__/ProgressBar.test.js +58 -0
  410. package/lib-esm/__tests__/SelectMenu.test.d.ts +1 -0
  411. package/lib-esm/__tests__/SelectMenu.test.js +145 -0
  412. package/lib-esm/__tests__/SelectPanel.test.d.ts +1 -0
  413. package/lib-esm/__tests__/SelectPanel.test.js +65 -0
  414. package/lib-esm/__tests__/SideNav.test.d.ts +1 -0
  415. package/lib-esm/__tests__/SideNav.test.js +60 -0
  416. package/lib-esm/__tests__/Spinner.test.d.ts +1 -0
  417. package/lib-esm/__tests__/Spinner.test.js +43 -0
  418. package/lib-esm/__tests__/StateLabel.test.d.ts +1 -0
  419. package/lib-esm/__tests__/StateLabel.test.js +61 -0
  420. package/lib-esm/__tests__/StyledOcticon.test.d.ts +1 -0
  421. package/lib-esm/__tests__/StyledOcticon.test.js +29 -0
  422. package/lib-esm/__tests__/SubNav.test.d.ts +1 -0
  423. package/lib-esm/__tests__/SubNav.test.js +50 -0
  424. package/lib-esm/__tests__/SubNavLink.test.d.ts +1 -0
  425. package/lib-esm/__tests__/SubNavLink.test.js +39 -0
  426. package/lib-esm/__tests__/TabNav.test.d.ts +1 -0
  427. package/lib-esm/__tests__/TabNav.test.js +39 -0
  428. package/lib-esm/__tests__/Text.test.d.ts +1 -0
  429. package/lib-esm/__tests__/Text.test.js +93 -0
  430. package/lib-esm/__tests__/TextInput.test.d.ts +1 -0
  431. package/lib-esm/__tests__/TextInput.test.js +68 -0
  432. package/lib-esm/__tests__/TextInputWithTokens.test.d.ts +1 -0
  433. package/lib-esm/__tests__/TextInputWithTokens.test.js +387 -0
  434. package/lib-esm/__tests__/ThemeProvider.test.d.ts +1 -0
  435. package/lib-esm/__tests__/ThemeProvider.test.js +408 -0
  436. package/lib-esm/__tests__/Timeline.test.d.ts +1 -0
  437. package/lib-esm/__tests__/Timeline.test.js +65 -0
  438. package/lib-esm/__tests__/Token.test.d.ts +1 -0
  439. package/lib-esm/__tests__/Token.test.js +166 -0
  440. package/lib-esm/__tests__/Tooltip.test.d.ts +1 -0
  441. package/lib-esm/__tests__/Tooltip.test.js +59 -0
  442. package/lib-esm/__tests__/Truncate.test.d.ts +1 -0
  443. package/lib-esm/__tests__/Truncate.test.js +53 -0
  444. package/lib-esm/__tests__/UnderlineNav.test.d.ts +1 -0
  445. package/lib-esm/__tests__/UnderlineNav.test.js +60 -0
  446. package/lib-esm/__tests__/UnderlineNavLink.test.d.ts +1 -0
  447. package/lib-esm/__tests__/UnderlineNavLink.test.js +41 -0
  448. package/lib-esm/__tests__/behaviors/anchoredPosition.test.d.ts +1 -0
  449. package/lib-esm/__tests__/behaviors/anchoredPosition.test.js +388 -0
  450. package/lib-esm/__tests__/behaviors/focusTrap.test.d.ts +1 -0
  451. package/lib-esm/__tests__/behaviors/focusTrap.test.js +227 -0
  452. package/lib-esm/__tests__/behaviors/focusZone.test.d.ts +1 -0
  453. package/lib-esm/__tests__/behaviors/focusZone.test.js +487 -0
  454. package/lib-esm/__tests__/behaviors/iterateFocusableElements.test.d.ts +1 -0
  455. package/lib-esm/__tests__/behaviors/iterateFocusableElements.test.js +48 -0
  456. package/lib-esm/__tests__/behaviors/scrollIntoViewingArea.test.d.ts +1 -0
  457. package/lib-esm/__tests__/behaviors/scrollIntoViewingArea.test.js +224 -0
  458. package/lib-esm/__tests__/filterObject.test.d.ts +1 -0
  459. package/lib-esm/__tests__/filterObject.test.js +27 -0
  460. package/lib-esm/__tests__/hooks/useAnchoredPosition.test.d.ts +1 -0
  461. package/lib-esm/__tests__/hooks/useAnchoredPosition.test.js +46 -0
  462. package/lib-esm/__tests__/hooks/useOnEscapePress.test.d.ts +1 -0
  463. package/lib-esm/__tests__/hooks/useOnEscapePress.test.js +23 -0
  464. package/lib-esm/__tests__/hooks/useOnOutsideClick.test.d.ts +1 -0
  465. package/lib-esm/__tests__/hooks/useOnOutsideClick.test.js +68 -0
  466. package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.test.d.ts +1 -0
  467. package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.test.js +52 -0
  468. package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.test.d.ts +1 -0
  469. package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.test.js +36 -0
  470. package/lib-esm/__tests__/theme.test.d.ts +1 -0
  471. package/lib-esm/__tests__/theme.test.js +33 -0
  472. package/lib-esm/__tests__/themeGet.test.d.ts +1 -0
  473. package/lib-esm/__tests__/themeGet.test.js +22 -0
  474. package/lib-esm/__tests__/useSafeTimeout.test.d.ts +1 -0
  475. package/lib-esm/__tests__/useSafeTimeout.test.js +39 -0
  476. package/lib-esm/stories/ActionList.stories.js +395 -0
  477. package/lib-esm/stories/ActionMenu.stories.js +305 -0
  478. package/lib-esm/stories/AnchoredOverlay.stories.js +101 -0
  479. package/lib-esm/stories/Autocomplete.stories.js +560 -0
  480. package/lib-esm/stories/AvatarStack.stories.js +32 -0
  481. package/lib-esm/stories/Button.stories.js +86 -0
  482. package/lib-esm/stories/ConfirmationDialog.stories.js +86 -0
  483. package/lib-esm/stories/Dialog.stories.js +240 -0
  484. package/lib-esm/stories/DropdownMenu.stories.js +94 -0
  485. package/lib-esm/stories/IssueLabelToken.stories.js +139 -0
  486. package/lib-esm/stories/Overlay.stories.js +173 -0
  487. package/lib-esm/stories/Portal.stories.js +68 -0
  488. package/lib-esm/stories/ProfileToken.stories.js +136 -0
  489. package/lib-esm/stories/SelectPanel.stories.js +334 -0
  490. package/lib-esm/stories/TextInputWithTokens.stories.js +196 -0
  491. package/lib-esm/stories/ThemeProvider.stories.js +83 -0
  492. package/lib-esm/stories/Token.stories.js +133 -0
  493. package/lib-esm/stories/useAnchoredPosition.stories.js +313 -0
  494. package/lib-esm/stories/useFocusTrap.stories.js +309 -0
  495. package/lib-esm/stories/useFocusZone.stories.js +554 -0
  496. package/migrating.md +250 -0
  497. package/now.json +17 -0
  498. package/package-lock.json +28456 -0
  499. package/package.json +6 -6
  500. package/rollup.config.js +36 -0
  501. package/script/build +19 -0
  502. package/script/build-storybook +10 -0
  503. package/script/setup +12 -0
  504. package/src/ActionList/Divider.tsx +25 -0
  505. package/src/ActionList/Group.tsx +45 -0
  506. package/src/ActionList/Header.tsx +74 -0
  507. package/src/ActionList/Item.tsx +496 -0
  508. package/src/ActionList/List.tsx +258 -0
  509. package/src/ActionList/index.ts +21 -0
  510. package/src/ActionMenu.tsx +106 -0
  511. package/src/AnchoredOverlay/AnchoredOverlay.tsx +191 -0
  512. package/src/AnchoredOverlay/index.ts +2 -0
  513. package/src/Autocomplete/Autocomplete.tsx +103 -0
  514. package/src/Autocomplete/AutocompleteContext.tsx +19 -0
  515. package/src/Autocomplete/AutocompleteInput.tsx +179 -0
  516. package/src/Autocomplete/AutocompleteMenu.tsx +341 -0
  517. package/src/Autocomplete/AutocompleteOverlay.tsx +68 -0
  518. package/src/Autocomplete/index.ts +2 -0
  519. package/src/Avatar.tsx +46 -0
  520. package/src/AvatarPair.tsx +35 -0
  521. package/src/AvatarStack.tsx +159 -0
  522. package/src/BaseStyles.tsx +53 -0
  523. package/src/BorderBox.tsx +18 -0
  524. package/src/Box.tsx +54 -0
  525. package/src/BranchName.tsx +19 -0
  526. package/src/Breadcrumbs.tsx +101 -0
  527. package/src/Button/Button.tsx +40 -0
  528. package/src/Button/ButtonBase.tsx +43 -0
  529. package/src/Button/ButtonClose.tsx +40 -0
  530. package/src/Button/ButtonDanger.tsx +43 -0
  531. package/src/Button/ButtonGroup.tsx +55 -0
  532. package/src/Button/ButtonInvisible.tsx +32 -0
  533. package/src/Button/ButtonOutline.tsx +43 -0
  534. package/src/Button/ButtonPrimary.tsx +41 -0
  535. package/src/Button/ButtonStyles.tsx +36 -0
  536. package/src/Button/ButtonTableList.tsx +58 -0
  537. package/src/Button/index.ts +16 -0
  538. package/src/Caret.tsx +133 -0
  539. package/src/CircleBadge.tsx +55 -0
  540. package/src/CircleOcticon.tsx +37 -0
  541. package/src/CounterLabel.tsx +52 -0
  542. package/src/Details.tsx +23 -0
  543. package/src/Dialog/ConfirmationDialog.tsx +184 -0
  544. package/src/Dialog/Dialog.tsx +432 -0
  545. package/src/Dialog.tsx +149 -0
  546. package/src/Dropdown.tsx +158 -0
  547. package/src/DropdownMenu/DropdownButton.tsx +15 -0
  548. package/src/DropdownMenu/DropdownMenu.tsx +115 -0
  549. package/src/DropdownMenu/index.ts +4 -0
  550. package/src/DropdownStyles.ts +128 -0
  551. package/src/FilterList.tsx +81 -0
  552. package/src/FilteredActionList/FilteredActionList.tsx +142 -0
  553. package/src/FilteredActionList/index.ts +2 -0
  554. package/src/FilteredSearch.tsx +28 -0
  555. package/src/Flash.tsx +77 -0
  556. package/src/Flex.tsx +15 -0
  557. package/src/FormGroup.tsx +27 -0
  558. package/src/Grid.tsx +15 -0
  559. package/src/Header.tsx +84 -0
  560. package/src/Heading.tsx +21 -0
  561. package/src/Label.tsx +75 -0
  562. package/src/LabelGroup.tsx +18 -0
  563. package/src/Link.tsx +46 -0
  564. package/src/Overlay.tsx +197 -0
  565. package/src/Pagehead.tsx +17 -0
  566. package/src/Pagination/Pagination.tsx +214 -0
  567. package/src/Pagination/index.ts +4 -0
  568. package/src/Pagination/model.tsx +187 -0
  569. package/src/PointerBox.tsx +31 -0
  570. package/src/Popover.tsx +236 -0
  571. package/src/Portal/Portal.tsx +96 -0
  572. package/src/Portal/index.ts +5 -0
  573. package/src/Position.tsx +63 -0
  574. package/src/ProgressBar.tsx +52 -0
  575. package/src/SelectMenu/SelectMenu.tsx +125 -0
  576. package/src/SelectMenu/SelectMenuContext.tsx +9 -0
  577. package/src/SelectMenu/SelectMenuDivider.tsx +25 -0
  578. package/src/SelectMenu/SelectMenuFilter.tsx +51 -0
  579. package/src/SelectMenu/SelectMenuFooter.tsx +28 -0
  580. package/src/SelectMenu/SelectMenuHeader.tsx +50 -0
  581. package/src/SelectMenu/SelectMenuItem.tsx +137 -0
  582. package/src/SelectMenu/SelectMenuList.tsx +42 -0
  583. package/src/SelectMenu/SelectMenuLoadingAnimation.tsx +24 -0
  584. package/src/SelectMenu/SelectMenuModal.tsx +121 -0
  585. package/src/SelectMenu/SelectMenuTab.tsx +88 -0
  586. package/src/SelectMenu/SelectMenuTabPanel.tsx +30 -0
  587. package/src/SelectMenu/SelectMenuTabs.tsx +44 -0
  588. package/src/SelectMenu/hooks/useKeyboardNav.js +90 -0
  589. package/src/SelectMenu/index.ts +15 -0
  590. package/src/SelectPanel/SelectPanel.tsx +173 -0
  591. package/src/SelectPanel/index.ts +2 -0
  592. package/src/SideNav.tsx +193 -0
  593. package/src/Spinner.tsx +59 -0
  594. package/src/StateLabel.tsx +102 -0
  595. package/src/StyledOcticon.tsx +24 -0
  596. package/src/SubNav.tsx +129 -0
  597. package/src/TabNav.tsx +77 -0
  598. package/src/Text.tsx +13 -0
  599. package/src/TextInput.tsx +68 -0
  600. package/src/TextInputWithTokens.tsx +295 -0
  601. package/src/ThemeProvider.tsx +176 -0
  602. package/src/Timeline.tsx +141 -0
  603. package/src/Token/AvatarToken.tsx +54 -0
  604. package/src/Token/IssueLabelToken.tsx +150 -0
  605. package/src/Token/Token.tsx +126 -0
  606. package/src/Token/TokenBase.tsx +129 -0
  607. package/src/Token/_RemoveTokenButton.tsx +111 -0
  608. package/src/Token/_TokenTextContainer.tsx +47 -0
  609. package/src/Token/index.ts +3 -0
  610. package/src/Tooltip.tsx +263 -0
  611. package/src/Truncate.tsx +36 -0
  612. package/src/UnderlineNav.tsx +110 -0
  613. package/src/_TextInputWrapper.tsx +105 -0
  614. package/src/_UnstyledTextInput.tsx +19 -0
  615. package/src/__tests__/.eslintrc.json +11 -0
  616. package/src/__tests__/ActionList.test.tsx +53 -0
  617. package/src/__tests__/ActionList.types.test.tsx +51 -0
  618. package/src/__tests__/ActionMenu.test.tsx +136 -0
  619. package/src/__tests__/AnchoredOverlay.test.tsx +150 -0
  620. package/src/__tests__/Autocomplete.test.tsx +444 -0
  621. package/src/__tests__/Avatar.test.tsx +44 -0
  622. package/src/__tests__/AvatarStack.test.tsx +48 -0
  623. package/src/__tests__/BorderBox.test.tsx +43 -0
  624. package/src/__tests__/Box.test.tsx +42 -0
  625. package/src/__tests__/BranchName.test.tsx +26 -0
  626. package/src/__tests__/Breadcrumbs.test.tsx +27 -0
  627. package/src/__tests__/BreadcrumbsItem.test.tsx +31 -0
  628. package/src/__tests__/Button.test.tsx +128 -0
  629. package/src/__tests__/Caret.test.tsx +36 -0
  630. package/src/__tests__/CircleBadge.test.tsx +66 -0
  631. package/src/__tests__/CircleOcticon.test.tsx +50 -0
  632. package/src/__tests__/ConfirmationDialog.test.tsx +120 -0
  633. package/src/__tests__/CounterLabel.test.tsx +50 -0
  634. package/src/__tests__/Details.test.tsx +115 -0
  635. package/src/__tests__/Dialog.test.tsx +155 -0
  636. package/src/__tests__/Dropdown.test.tsx +53 -0
  637. package/src/__tests__/DropdownMenu.test.tsx +136 -0
  638. package/src/__tests__/FilterList.test.tsx +26 -0
  639. package/src/__tests__/FilterListItem.test.tsx +31 -0
  640. package/src/__tests__/FilteredSearch.test.tsx +26 -0
  641. package/src/__tests__/Flash.test.tsx +45 -0
  642. package/src/__tests__/Flex.test.tsx +58 -0
  643. package/src/__tests__/FormGroup.test.tsx +38 -0
  644. package/src/__tests__/Grid.test.tsx +82 -0
  645. package/src/__tests__/Header.test.tsx +49 -0
  646. package/src/__tests__/Heading.test.tsx +91 -0
  647. package/src/__tests__/Label.test.tsx +34 -0
  648. package/src/__tests__/LabelGroup.test.tsx +30 -0
  649. package/src/__tests__/Link.test.tsx +47 -0
  650. package/src/__tests__/Merge.types.test.ts +39 -0
  651. package/src/__tests__/Overlay.test.tsx +103 -0
  652. package/src/__tests__/Pagehead.test.tsx +23 -0
  653. package/src/__tests__/Pagination/Pagination.test.tsx +30 -0
  654. package/src/__tests__/Pagination/PaginationModel.test.tsx +133 -0
  655. package/src/__tests__/Pagination/__snapshots__/Pagination.test.tsx.snap +184 -0
  656. package/src/__tests__/PointerBox.test.tsx +34 -0
  657. package/src/__tests__/Popover.test.tsx +68 -0
  658. package/src/__tests__/Portal.test.tsx +103 -0
  659. package/src/__tests__/Position.test.tsx +117 -0
  660. package/src/__tests__/ProgressBar.test.tsx +40 -0
  661. package/src/__tests__/SelectMenu.test.tsx +142 -0
  662. package/src/__tests__/SelectPanel.test.tsx +63 -0
  663. package/src/__tests__/SideNav.test.tsx +62 -0
  664. package/src/__tests__/Spinner.test.tsx +42 -0
  665. package/src/__tests__/StateLabel.test.tsx +48 -0
  666. package/src/__tests__/StyledOcticon.test.tsx +26 -0
  667. package/src/__tests__/SubNav.test.tsx +50 -0
  668. package/src/__tests__/SubNavLink.test.tsx +31 -0
  669. package/src/__tests__/TabNav.test.tsx +32 -0
  670. package/src/__tests__/Text.test.tsx +78 -0
  671. package/src/__tests__/TextInput.test.tsx +49 -0
  672. package/src/__tests__/TextInputWithTokens.test.tsx +300 -0
  673. package/src/__tests__/ThemeProvider.test.tsx +441 -0
  674. package/src/__tests__/Timeline.test.tsx +58 -0
  675. package/src/__tests__/Token.test.tsx +118 -0
  676. package/src/__tests__/Tooltip.test.tsx +52 -0
  677. package/src/__tests__/Truncate.test.tsx +43 -0
  678. package/src/__tests__/UnderlineNav.test.tsx +58 -0
  679. package/src/__tests__/UnderlineNavLink.test.tsx +31 -0
  680. package/src/__tests__/__snapshots__/ActionList.test.tsx.snap +223 -0
  681. package/src/__tests__/__snapshots__/ActionMenu.test.tsx.snap +80 -0
  682. package/src/__tests__/__snapshots__/AnchoredOverlay.test.tsx.snap +332 -0
  683. package/src/__tests__/__snapshots__/Autocomplete.test.tsx.snap +3414 -0
  684. package/src/__tests__/__snapshots__/Avatar.test.tsx.snap +19 -0
  685. package/src/__tests__/__snapshots__/AvatarStack.test.tsx.snap +377 -0
  686. package/src/__tests__/__snapshots__/BorderBox.test.tsx.snap +14 -0
  687. package/src/__tests__/__snapshots__/Box.test.tsx.snap +201 -0
  688. package/src/__tests__/__snapshots__/BranchName.test.tsx.snap +17 -0
  689. package/src/__tests__/__snapshots__/Breadcrumbs.test.tsx.snap +29 -0
  690. package/src/__tests__/__snapshots__/BreadcrumbsItem.test.tsx.snap +79 -0
  691. package/src/__tests__/__snapshots__/Button.test.tsx.snap +840 -0
  692. package/src/__tests__/__snapshots__/Caret.test.tsx.snap +373 -0
  693. package/src/__tests__/__snapshots__/CircleBadge.test.tsx.snap +141 -0
  694. package/src/__tests__/__snapshots__/CircleOcticon.test.tsx.snap +64 -0
  695. package/src/__tests__/__snapshots__/ConfirmationDialog.test.tsx.snap +89 -0
  696. package/src/__tests__/__snapshots__/CounterLabel.test.tsx.snap +22 -0
  697. package/src/__tests__/__snapshots__/Details.test.tsx.snap +15 -0
  698. package/src/__tests__/__snapshots__/Dialog.test.tsx.snap +200 -0
  699. package/src/__tests__/__snapshots__/Dropdown.test.tsx.snap +249 -0
  700. package/src/__tests__/__snapshots__/DropdownMenu.test.tsx.snap +106 -0
  701. package/src/__tests__/__snapshots__/FilterList.test.tsx.snap +13 -0
  702. package/src/__tests__/__snapshots__/FilterListItem.test.tsx.snap +80 -0
  703. package/src/__tests__/__snapshots__/FilteredSearch.test.tsx.snap +32 -0
  704. package/src/__tests__/__snapshots__/Flash.test.tsx.snap +32 -0
  705. package/src/__tests__/__snapshots__/Flex.test.tsx.snap +130 -0
  706. package/src/__tests__/__snapshots__/FormGroup.test.tsx.snap +25 -0
  707. package/src/__tests__/__snapshots__/Grid.test.tsx.snap +178 -0
  708. package/src/__tests__/__snapshots__/Header.test.tsx.snap +79 -0
  709. package/src/__tests__/__snapshots__/Heading.test.tsx.snap +13 -0
  710. package/src/__tests__/__snapshots__/Label.test.tsx.snap +74 -0
  711. package/src/__tests__/__snapshots__/LabelGroup.test.tsx.snap +15 -0
  712. package/src/__tests__/__snapshots__/Link.test.tsx.snap +213 -0
  713. package/src/__tests__/__snapshots__/Pagehead.test.tsx.snap +15 -0
  714. package/src/__tests__/__snapshots__/PointerBox.test.tsx.snap +174 -0
  715. package/src/__tests__/__snapshots__/Popover.test.tsx.snap +4687 -0
  716. package/src/__tests__/__snapshots__/Position.test.tsx.snap +44 -0
  717. package/src/__tests__/__snapshots__/ProgressBar.test.tsx.snap +53 -0
  718. package/src/__tests__/__snapshots__/SelectMenu.test.tsx.snap +469 -0
  719. package/src/__tests__/__snapshots__/SelectPanel.test.tsx.snap +123 -0
  720. package/src/__tests__/__snapshots__/SideNav.test.tsx.snap +143 -0
  721. package/src/__tests__/__snapshots__/Spinner.test.tsx.snap +33 -0
  722. package/src/__tests__/__snapshots__/StateLabel.test.tsx.snap +388 -0
  723. package/src/__tests__/__snapshots__/StyledOcticon.test.tsx.snap +25 -0
  724. package/src/__tests__/__snapshots__/SubNav.test.tsx.snap +44 -0
  725. package/src/__tests__/__snapshots__/SubNavLink.test.tsx.snap +199 -0
  726. package/src/__tests__/__snapshots__/TabNav.test.tsx.snap +58 -0
  727. package/src/__tests__/__snapshots__/Text.test.tsx.snap +7 -0
  728. package/src/__tests__/__snapshots__/TextInput.test.tsx.snap +440 -0
  729. package/src/__tests__/__snapshots__/TextInputWithTokens.test.tsx.snap +5516 -0
  730. package/src/__tests__/__snapshots__/ThemeProvider.test.tsx.snap +15 -0
  731. package/src/__tests__/__snapshots__/Timeline.test.tsx.snap +159 -0
  732. package/src/__tests__/__snapshots__/Token.test.tsx.snap +3794 -0
  733. package/src/__tests__/__snapshots__/Tooltip.test.tsx.snap +227 -0
  734. package/src/__tests__/__snapshots__/Truncate.test.tsx.snap +17 -0
  735. package/src/__tests__/__snapshots__/UnderlineNav.test.tsx.snap +59 -0
  736. package/src/__tests__/__snapshots__/UnderlineNavLink.test.tsx.snap +130 -0
  737. package/src/__tests__/behaviors/anchoredPosition.test.ts +295 -0
  738. package/src/__tests__/behaviors/focusTrap.test.tsx +236 -0
  739. package/src/__tests__/behaviors/focusZone.test.tsx +549 -0
  740. package/src/__tests__/behaviors/iterateFocusableElements.test.tsx +61 -0
  741. package/src/__tests__/behaviors/scrollIntoViewingArea.test.ts +195 -0
  742. package/src/__tests__/filterObject.test.ts +54 -0
  743. package/src/__tests__/hooks/useAnchoredPosition.test.tsx +31 -0
  744. package/src/__tests__/hooks/useOnEscapePress.test.tsx +16 -0
  745. package/src/__tests__/hooks/useOnOutsideClick.test.tsx +48 -0
  746. package/src/__tests__/hooks/useOpenAndCloseFocus.test.tsx +48 -0
  747. package/src/__tests__/hooks/useProvidedStateOrCreate.test.tsx +39 -0
  748. package/src/__tests__/theme.test.ts +41 -0
  749. package/src/__tests__/themeGet.test.ts +15 -0
  750. package/src/__tests__/useSafeTimeout.test.tsx +36 -0
  751. package/src/behaviors/anchoredPosition.ts +442 -0
  752. package/src/behaviors/focusTrap.ts +184 -0
  753. package/src/behaviors/focusZone.ts +713 -0
  754. package/src/behaviors/scrollIntoViewingArea.ts +27 -0
  755. package/src/constants.ts +62 -0
  756. package/src/hooks/index.ts +11 -0
  757. package/src/hooks/useAnchoredPosition.ts +53 -0
  758. package/src/hooks/useCombinedRefs.ts +40 -0
  759. package/src/hooks/useDetails.tsx +54 -0
  760. package/src/hooks/useDialog.ts +121 -0
  761. package/src/hooks/useFocusTrap.ts +80 -0
  762. package/src/hooks/useFocusZone.ts +64 -0
  763. package/src/hooks/useOnEscapePress.ts +63 -0
  764. package/src/hooks/useOnOutsideClick.tsx +82 -0
  765. package/src/hooks/useOpenAndCloseFocus.ts +32 -0
  766. package/src/hooks/useOverlay.tsx +34 -0
  767. package/src/hooks/useProvidedRefOrCreate.ts +14 -0
  768. package/src/hooks/useProvidedStateOrCreate.ts +27 -0
  769. package/src/hooks/useRenderForcingRef.ts +22 -0
  770. package/src/hooks/useResizeObserver.ts +11 -0
  771. package/src/hooks/useSafeTimeout.ts +38 -0
  772. package/src/hooks/useScrollFlash.ts +21 -0
  773. package/src/index.ts +170 -0
  774. package/src/polyfills/eventListenerSignal.ts +66 -0
  775. package/src/stories/ActionList.stories.tsx +436 -0
  776. package/src/stories/ActionMenu.stories.tsx +334 -0
  777. package/src/stories/AnchoredOverlay.stories.tsx +117 -0
  778. package/src/stories/Autocomplete.stories.tsx +655 -0
  779. package/src/stories/AvatarStack.stories.tsx +37 -0
  780. package/src/stories/Button.stories.tsx +92 -0
  781. package/src/stories/ConfirmationDialog.stories.tsx +105 -0
  782. package/src/stories/Dialog.stories.tsx +240 -0
  783. package/src/stories/DropdownMenu.stories.tsx +84 -0
  784. package/src/stories/IssueLabelToken.stories.tsx +138 -0
  785. package/src/stories/Overlay.stories.tsx +213 -0
  786. package/src/stories/Portal.stories.tsx +109 -0
  787. package/src/stories/ProfileToken.stories.tsx +129 -0
  788. package/src/stories/SelectPanel.stories.tsx +353 -0
  789. package/src/stories/TextInputWithTokens.stories.tsx +146 -0
  790. package/src/stories/ThemeProvider.stories.tsx +104 -0
  791. package/src/stories/Token.stories.tsx +126 -0
  792. package/src/stories/useAnchoredPosition.stories.tsx +332 -0
  793. package/src/stories/useFocusTrap.stories.tsx +400 -0
  794. package/src/stories/useFocusZone.stories.tsx +663 -0
  795. package/src/sx.ts +9 -0
  796. package/src/theme-preval.js +79 -0
  797. package/src/theme.ts +3 -0
  798. package/src/utils/deprecate.tsx +73 -0
  799. package/src/utils/isNumeric.tsx +4 -0
  800. package/src/utils/iterateFocusableElements.ts +121 -0
  801. package/src/utils/ssr.tsx +1 -0
  802. package/src/utils/test-deprecations.tsx +19 -0
  803. package/src/utils/test-helpers.tsx +7 -0
  804. package/src/utils/test-matchers.tsx +109 -0
  805. package/src/utils/testing.tsx +242 -0
  806. package/src/utils/theme.js +64 -0
  807. package/src/utils/types/AriaRole.ts +71 -0
  808. package/src/utils/types/ComponentProps.ts +13 -0
  809. package/src/utils/types/Flatten.ts +4 -0
  810. package/src/utils/types/MandateProps.ts +19 -0
  811. package/src/utils/types/Merge.ts +20 -0
  812. package/src/utils/types/index.ts +5 -0
  813. package/src/utils/uniqueId.ts +6 -0
  814. package/src/utils/userAgent.ts +7 -0
  815. package/stats.html +3279 -0
  816. package/tsconfig.build.json +7 -0
  817. package/tsconfig.json +20 -0
@@ -0,0 +1,258 @@
1
+ import React, {Key} from 'react'
2
+ import type {AriaRole} from '../utils/types'
3
+ import {Group, GroupProps} from './Group'
4
+ import {Item, ItemProps} from './Item'
5
+ import {Divider} from './Divider'
6
+ import styled from 'styled-components'
7
+ import {get} from '../constants'
8
+ import {SystemCssProperties} from '@styled-system/css'
9
+ import {hasActiveDescendantAttribute} from '../behaviors/focusZone'
10
+ import {Merge} from '../utils/types/Merge'
11
+
12
+ type RenderItemFn = (props: ItemProps) => React.ReactElement
13
+
14
+ export type ItemInput =
15
+ | Merge<React.ComponentPropsWithoutRef<'div'>, ItemProps>
16
+ | ((Partial<ItemProps> & {renderItem: RenderItemFn}) & {key?: Key})
17
+
18
+ /**
19
+ * Contract for props passed to the `List` component.
20
+ */
21
+ export interface ListPropsBase {
22
+ /**
23
+ * A collection of `Item` props and `Item`-level custom `Item` renderers.
24
+ */
25
+ items: ItemInput[]
26
+
27
+ /**
28
+ * The ARIA role describing the function of `List` component. `listbox` is a common value.
29
+ */
30
+ role?: AriaRole
31
+
32
+ /**
33
+ * id to attach to the base DOM node of the list
34
+ */
35
+ id?: string
36
+
37
+ /**
38
+ * A `List`-level custom `Item` renderer. Every `Item` within this `List`
39
+ * without a `Group`-level or `Item`-level custom `Item` renderer will be
40
+ * rendered using this function component.
41
+ */
42
+ renderItem?: RenderItemFn
43
+
44
+ /**
45
+ * A `List`-level custom `Group` renderer. Every `Group` within this `List`
46
+ * without a `Group`-level custom `Item` renderer will be rendered using
47
+ * this function component.
48
+ */
49
+ renderGroup?: typeof Group
50
+
51
+ /**
52
+ * Style variations. Usage is discretionary.
53
+ *
54
+ * - `"inset"` - `List` children are offset (vertically and horizontally) from `List`’s edges
55
+ * - `"full"` - `List` children are flush (vertically and horizontally) with `List` edges
56
+ */
57
+ variant?: 'inset' | 'full'
58
+
59
+ /**
60
+ * For `Item`s which can be selected, whether `multiple` `Item`s or a `single` `Item` can be selected
61
+ */
62
+ selectionVariant?: 'single' | 'multiple'
63
+
64
+ /**
65
+ * Whether to display a divider above each `Item` in this `List` when it does not follow a `Header` or `Divider`.
66
+ */
67
+ showItemDividers?: boolean
68
+ }
69
+
70
+ /**
71
+ * Contract for props passed to the `List` component, when its `Item`s are collected in `Group`s.
72
+ */
73
+ export interface GroupedListProps extends ListPropsBase {
74
+ /**
75
+ * A collection of `Group` props (except `items`), plus a unique group identifier
76
+ * and `Group`-level custom `Item` or `Group` renderers.
77
+ */
78
+ groupMetadata: ((
79
+ | Omit<GroupProps, 'items'>
80
+ | Omit<Partial<GroupProps> & {renderItem?: RenderItemFn; renderGroup?: typeof Group}, 'items'>
81
+ ) & {groupId: string})[]
82
+
83
+ /**
84
+ * A collection of `Item` props, plus associated group identifiers
85
+ * and `Item`-level custom `Item` renderers.
86
+ */
87
+ items: ((ItemProps | (Partial<ItemProps> & {renderItem: RenderItemFn})) & {groupId: string})[]
88
+ }
89
+
90
+ /**
91
+ * Asserts that the given value fulfills the `GroupedListProps` contract.
92
+ * @param props A value which fulfills either the `ListPropsBase` or the `GroupedListProps` contract.
93
+ */
94
+ function isGroupedListProps(props: ListProps): props is GroupedListProps {
95
+ return 'groupMetadata' in props
96
+ }
97
+
98
+ /**
99
+ * Contract for props passed to the `List` component.
100
+ */
101
+ export type ListProps = ListPropsBase | GroupedListProps
102
+
103
+ const StyledList = styled.div`
104
+ font-size: ${get('fontSizes.1')};
105
+ /* 14px font-size * 1.428571429 = 20px line height
106
+ *
107
+ * TODO: When rem-based spacing on a 4px scale lands, replace
108
+ * hardcoded '20px'
109
+ */
110
+ line-height: 20px;
111
+
112
+ &[${hasActiveDescendantAttribute}], &:focus-within {
113
+ --item-hover-bg-override: none;
114
+ --item-hover-divider-border-color-override: ${get('colors.border.muted')};
115
+ }
116
+ `
117
+
118
+ /**
119
+ * Returns `sx` prop values for `List` children matching the given `List` style variation.
120
+ * @param variant `List` style variation.
121
+ */
122
+ function useListVariant(variant: ListProps['variant'] = 'inset'): {
123
+ firstGroupStyle?: SystemCssProperties
124
+ lastGroupStyle?: SystemCssProperties
125
+ headerStyle?: SystemCssProperties
126
+ itemStyle?: SystemCssProperties
127
+ } {
128
+ switch (variant) {
129
+ case 'full':
130
+ return {
131
+ headerStyle: {paddingX: get('space.2')},
132
+ itemStyle: {borderRadius: 0}
133
+ }
134
+ default:
135
+ return {
136
+ firstGroupStyle: {marginTop: get('space.2')},
137
+ lastGroupStyle: {marginBottom: get('space.2')},
138
+ itemStyle: {marginX: get('space.2')}
139
+ }
140
+ }
141
+ }
142
+
143
+ /**
144
+ * Lists `Item`s, either grouped or ungrouped, with a `Divider` between each `Group`.
145
+ */
146
+ export const List = React.forwardRef<HTMLDivElement, ListProps>((props, forwardedRef): JSX.Element => {
147
+ // Get `sx` prop values for `List` children matching the given `List` style variation.
148
+ const {firstGroupStyle, lastGroupStyle, headerStyle, itemStyle} = useListVariant(props.variant)
149
+
150
+ /**
151
+ * Render a `Group` using the first of the following renderers that is defined:
152
+ * A `Group`-level or `List`-level custom `Group` renderer, or
153
+ * the default `Group` renderer.
154
+ */
155
+ const renderGroup = (
156
+ groupProps: GroupProps | (Partial<GroupProps> & {renderItem?: typeof Item; renderGroup?: typeof Group})
157
+ ) => {
158
+ const GroupComponent = (('renderGroup' in groupProps && groupProps.renderGroup) ?? props.renderGroup) || Group
159
+ return <GroupComponent {...groupProps} key={groupProps.groupId} />
160
+ }
161
+
162
+ /**
163
+ * Render an `Item` using the first of the following renderers that is defined:
164
+ * An `Item`-level, `Group`-level, or `List`-level custom `Item` renderer,
165
+ * or the default `Item` renderer.
166
+ */
167
+ const renderItem = (itemProps: ItemInput, item: ItemInput, itemIndex: number) => {
168
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
169
+ const ItemComponent = ('renderItem' in itemProps && itemProps.renderItem) || props.renderItem || Item
170
+ const key = ('key' in itemProps ? itemProps.key : undefined) ?? itemProps.id?.toString() ?? itemIndex.toString()
171
+ return (
172
+ <ItemComponent
173
+ showDivider={props.showItemDividers}
174
+ selectionVariant={props.selectionVariant}
175
+ {...itemProps}
176
+ key={key}
177
+ sx={{...itemStyle, ...itemProps.sx}}
178
+ item={item}
179
+ />
180
+ )
181
+ }
182
+
183
+ /**
184
+ * An array of `Group`s, each with an associated `Header` and with an array of `Item`s belonging to that `Group`.
185
+ */
186
+ let groups: (GroupProps | (Partial<GroupProps> & {renderItem?: typeof Item; renderGroup?: typeof Group}))[] = []
187
+
188
+ // Collect rendered `Item`s into `Group`s, avoiding excess iteration over the lists of `items` and `groupMetadata`:
189
+ if (!isGroupedListProps(props)) {
190
+ // When no `groupMetadata`s is provided, collect rendered `Item`s into a single anonymous `Group`.
191
+ groups = [{items: props.items.map((item, index) => renderItem(item, item, index)), groupId: '0'}]
192
+ } else {
193
+ // When `groupMetadata` is provided, collect rendered `Item`s into their associated `Group`s.
194
+
195
+ /**
196
+ * A map of group identifiers to `Group`s, each with an associated array of `Item`s belonging to that `Group`.
197
+ */
198
+ const groupMap = props.groupMetadata.reduce(
199
+ (groupAccumulator, groupMetadata) => groupAccumulator.set(groupMetadata.groupId, groupMetadata),
200
+ new Map<string, GroupProps | (Partial<GroupProps> & {renderItem?: typeof Item; renderGroup?: typeof Group})>()
201
+ )
202
+
203
+ for (const itemProps of props.items) {
204
+ // Look up the group associated with the current item.
205
+ const group = groupMap.get(itemProps.groupId)
206
+ const itemIndex = group?.items?.length ?? 0
207
+
208
+ // Upsert the group to include the current item (rendered).
209
+ groupMap.set(itemProps.groupId, {
210
+ ...group,
211
+ items: [
212
+ ...(group?.items ?? []),
213
+ renderItem(
214
+ {
215
+ showDivider: group?.showItemDividers,
216
+ ...(group && 'renderItem' in group && {renderItem: group.renderItem}),
217
+ ...itemProps
218
+ },
219
+ itemProps,
220
+ itemIndex
221
+ )
222
+ ]
223
+ })
224
+ }
225
+
226
+ groups = [...groupMap.values()]
227
+ }
228
+
229
+ return (
230
+ <StyledList {...props} ref={forwardedRef}>
231
+ {groups.map(({header, ...groupProps}, index) => {
232
+ const hasFilledHeader = header?.variant === 'filled'
233
+ const shouldShowDivider = index > 0 && !hasFilledHeader
234
+ return (
235
+ <React.Fragment key={groupProps.groupId}>
236
+ {shouldShowDivider ? <Divider key={`${groupProps.groupId}-divider`} /> : null}
237
+ {renderGroup({
238
+ sx: {
239
+ ...(index === 0 && firstGroupStyle),
240
+ ...(index === groups.length - 1 && lastGroupStyle),
241
+ ...(index > 0 && !shouldShowDivider && {mt: 2})
242
+ },
243
+ ...(header && {
244
+ header: {
245
+ ...header,
246
+ sx: {...headerStyle, ...header.sx}
247
+ }
248
+ }),
249
+ ...groupProps
250
+ })}
251
+ </React.Fragment>
252
+ )
253
+ })}
254
+ </StyledList>
255
+ )
256
+ })
257
+
258
+ List.displayName = 'ActionList'
@@ -0,0 +1,21 @@
1
+ import {List} from './List'
2
+ import {Group} from './Group'
3
+ import {Item} from './Item'
4
+ import {Divider} from './Divider'
5
+ export type {ListProps as ActionListProps} from './List'
6
+ export type {GroupProps} from './Group'
7
+ export type {ItemProps} from './Item'
8
+
9
+ /**
10
+ * Collection of list-related components.
11
+ */
12
+ export const ActionList = Object.assign(List, {
13
+ /** Collects related `Items` in an `ActionList`. */
14
+ Group,
15
+
16
+ /** An actionable or selectable `Item` with an optional icon and description. */
17
+ Item,
18
+
19
+ /** Visually separates `Item`s or `Group`s in an `ActionList`. */
20
+ Divider
21
+ })
@@ -0,0 +1,106 @@
1
+ import {GroupedListProps, List, ListPropsBase} from './ActionList/List'
2
+ import {Item, ItemProps} from './ActionList/Item'
3
+ import {Divider} from './ActionList/Divider'
4
+ import Button, {ButtonProps} from './Button'
5
+ import React, {useCallback, useMemo} from 'react'
6
+ import {AnchoredOverlay} from './AnchoredOverlay'
7
+ import {useProvidedStateOrCreate} from './hooks/useProvidedStateOrCreate'
8
+ import {OverlayProps} from './Overlay'
9
+ import {useProvidedRefOrCreate} from './hooks'
10
+ import {AnchoredOverlayWrapperAnchorProps} from './AnchoredOverlay/AnchoredOverlay'
11
+
12
+ interface ActionMenuBaseProps extends Partial<Omit<GroupedListProps, keyof ListPropsBase>>, ListPropsBase {
13
+ /**
14
+ * Content that is passed into the renderAnchor component, which is a button by default.
15
+ */
16
+ anchorContent?: React.ReactNode
17
+
18
+ /**
19
+ * A callback that triggers both on clicks and keyboard events. This callback will be overridden by item level `onAction` callbacks.
20
+ */
21
+ onAction?: (props: ItemProps, event?: React.MouseEvent<HTMLDivElement> | React.KeyboardEvent<HTMLDivElement>) => void
22
+
23
+ /**
24
+ * If defined, will control the open/closed state of the overlay. Must be used in conjuction with `setOpen`.
25
+ */
26
+ open?: boolean
27
+
28
+ /**
29
+ * If defined, will control the open/closed state of the overlay. Must be used in conjuction with `open`.
30
+ */
31
+ setOpen?: (s: boolean) => void
32
+
33
+ /**
34
+ * Props to be spread on the internal `Overlay` component.
35
+ */
36
+ overlayProps?: Partial<OverlayProps>
37
+ }
38
+
39
+ export type ActionMenuProps = ActionMenuBaseProps & AnchoredOverlayWrapperAnchorProps
40
+
41
+ const ActionMenuItem = (props: ItemProps) => <Item role="menuitem" {...props} />
42
+
43
+ ActionMenuItem.displayName = 'ActionMenu.Item'
44
+
45
+ const ActionMenuBase = ({
46
+ anchorContent,
47
+ renderAnchor = <T extends ButtonProps>(props: T) => <Button {...props} />,
48
+ anchorRef: externalAnchorRef,
49
+ onAction,
50
+ open,
51
+ setOpen,
52
+ overlayProps,
53
+ items,
54
+ ...listProps
55
+ }: ActionMenuProps): JSX.Element => {
56
+ const [combinedOpenState, setCombinedOpenState] = useProvidedStateOrCreate(open, setOpen, false)
57
+ const anchorRef = useProvidedRefOrCreate(externalAnchorRef)
58
+ const onOpen = useCallback(() => setCombinedOpenState(true), [setCombinedOpenState])
59
+ const onClose = useCallback(() => setCombinedOpenState(false), [setCombinedOpenState])
60
+
61
+ const renderMenuAnchor = useMemo(() => {
62
+ if (renderAnchor === null) {
63
+ return null
64
+ }
65
+ return <T extends React.HTMLAttributes<HTMLElement>>(props: T) => {
66
+ return renderAnchor({
67
+ 'aria-label': 'menu',
68
+ children: anchorContent,
69
+ ...props
70
+ })
71
+ }
72
+ }, [anchorContent, renderAnchor])
73
+
74
+ const itemsToRender = useMemo(() => {
75
+ return items.map(item => {
76
+ return {
77
+ ...item,
78
+ role: 'menuitem',
79
+ onAction: (props, event) => {
80
+ const actionCallback = item.onAction ?? onAction
81
+ actionCallback?.(props as ItemProps, event)
82
+ if (!event.defaultPrevented) {
83
+ onClose()
84
+ }
85
+ }
86
+ } as ItemProps
87
+ })
88
+ }, [items, onAction, onClose])
89
+
90
+ return (
91
+ <AnchoredOverlay
92
+ renderAnchor={renderMenuAnchor}
93
+ anchorRef={anchorRef}
94
+ open={combinedOpenState}
95
+ onOpen={onOpen}
96
+ onClose={onClose}
97
+ overlayProps={overlayProps}
98
+ >
99
+ <List {...listProps} role="menu" items={itemsToRender} />
100
+ </AnchoredOverlay>
101
+ )
102
+ }
103
+
104
+ ActionMenuBase.displayName = 'ActionMenu'
105
+
106
+ export const ActionMenu = Object.assign(ActionMenuBase, {Divider, Item: ActionMenuItem})
@@ -0,0 +1,191 @@
1
+ import React, {useCallback, useEffect} from 'react'
2
+ import Overlay, {OverlayProps} from '../Overlay'
3
+ import {FocusTrapHookSettings, useFocusTrap} from '../hooks/useFocusTrap'
4
+ import {FocusZoneHookSettings, useFocusZone} from '../hooks/useFocusZone'
5
+ import {useAnchoredPosition, useProvidedRefOrCreate, useRenderForcingRef} from '../hooks'
6
+ import {useSSRSafeId} from '@react-aria/ssr'
7
+ import {PositionSettings} from '../behaviors/anchoredPosition'
8
+
9
+ interface AnchoredOverlayPropsWithAnchor {
10
+ /**
11
+ * A custom function component used to render the anchor element.
12
+ * Will receive the selected text as `children` prop when an item is activated.
13
+ */
14
+ renderAnchor: <T extends React.HTMLAttributes<HTMLElement>>(props: T) => JSX.Element
15
+
16
+ /**
17
+ * An override to the internal ref that will be spread on to the renderAnchor
18
+ */
19
+ anchorRef?: React.RefObject<HTMLElement>
20
+ }
21
+
22
+ interface AnchoredOverlayPropsWithoutAnchor {
23
+ /**
24
+ * A custom function component used to render the anchor element.
25
+ * When renderAnchor is null, an anchorRef is required.
26
+ */
27
+ renderAnchor: null
28
+
29
+ /**
30
+ * An override to the internal renderAnchor ref that will be used to position the overlay.
31
+ * When renderAnchor is null this can be used to make an anchor that is detached from ActionMenu.
32
+ */
33
+ anchorRef: React.RefObject<HTMLElement>
34
+ }
35
+
36
+ export type AnchoredOverlayWrapperAnchorProps =
37
+ | Partial<AnchoredOverlayPropsWithAnchor>
38
+ | AnchoredOverlayPropsWithoutAnchor
39
+
40
+ interface AnchoredOverlayBaseProps extends Pick<OverlayProps, 'height' | 'width'> {
41
+ /**
42
+ * Determines whether the overlay portion of the component should be shown or not
43
+ */
44
+ open: boolean
45
+
46
+ /**
47
+ * A callback which is called whenever the overlay is currently closed and an "open gesture" is detected.
48
+ */
49
+ onOpen?: (gesture: 'anchor-click' | 'anchor-key-press') => unknown
50
+
51
+ /**
52
+ * A callback which is called whenever the overlay is currently open and a "close gesture" is detected.
53
+ */
54
+ onClose?: (gesture: 'anchor-click' | 'click-outside' | 'escape') => unknown
55
+
56
+ /**
57
+ * Props to be spread on the internal `Overlay` component.
58
+ */
59
+ overlayProps?: Partial<OverlayProps>
60
+
61
+ /**
62
+ * Settings to apply to the Focus Zone on the internal `Overlay` component.
63
+ */
64
+ focusTrapSettings?: Partial<FocusTrapHookSettings>
65
+
66
+ /**
67
+ * Settings to apply to the Focus Zone on the internal `Overlay` component.
68
+ */
69
+ focusZoneSettings?: Partial<FocusZoneHookSettings>
70
+ }
71
+
72
+ export type AnchoredOverlayProps = AnchoredOverlayBaseProps &
73
+ (AnchoredOverlayPropsWithAnchor | AnchoredOverlayPropsWithoutAnchor) &
74
+ Partial<Pick<PositionSettings, 'align' | 'side'>>
75
+
76
+ /**
77
+ * An `AnchoredOverlay` provides an anchor that will open a floating overlay positioned relative to the anchor.
78
+ * The overlay can be opened and navigated using keyboard or mouse.
79
+ */
80
+ export const AnchoredOverlay: React.FC<AnchoredOverlayProps> = ({
81
+ renderAnchor,
82
+ anchorRef: externalAnchorRef,
83
+ children,
84
+ open,
85
+ onOpen,
86
+ onClose,
87
+ height,
88
+ width,
89
+ overlayProps,
90
+ focusTrapSettings,
91
+ focusZoneSettings,
92
+ side,
93
+ align
94
+ }) => {
95
+ const anchorRef = useProvidedRefOrCreate(externalAnchorRef)
96
+ const [overlayRef, updateOverlayRef] = useRenderForcingRef<HTMLDivElement>()
97
+ const anchorId = useSSRSafeId()
98
+
99
+ const onClickOutside = useCallback(() => onClose?.('click-outside'), [onClose])
100
+ const onEscape = useCallback(() => onClose?.('escape'), [onClose])
101
+
102
+ const onAnchorKeyDown = useCallback(
103
+ (event: React.KeyboardEvent<HTMLElement>) => {
104
+ if (!event.defaultPrevented) {
105
+ if (!open && ['ArrowDown', 'ArrowUp', ' ', 'Enter'].includes(event.key)) {
106
+ onOpen?.('anchor-key-press')
107
+ event.preventDefault()
108
+ }
109
+ }
110
+ },
111
+ [open, onOpen]
112
+ )
113
+ const onAnchorClick = useCallback(
114
+ (event: React.MouseEvent<HTMLElement>) => {
115
+ if (event.defaultPrevented || event.button !== 0) {
116
+ return
117
+ }
118
+ if (!open) {
119
+ onOpen?.('anchor-click')
120
+ } else {
121
+ onClose?.('anchor-click')
122
+ }
123
+ },
124
+ [open, onOpen, onClose]
125
+ )
126
+
127
+ const {position} = useAnchoredPosition(
128
+ {
129
+ anchorElementRef: anchorRef,
130
+ floatingElementRef: overlayRef,
131
+ side,
132
+ align
133
+ },
134
+ [overlayRef.current]
135
+ )
136
+
137
+ useEffect(() => {
138
+ // ensure overlay ref gets cleared when closed, so position can reset between closing/re-opening
139
+ if (!open && overlayRef.current) {
140
+ updateOverlayRef(null)
141
+ }
142
+ }, [open, overlayRef, updateOverlayRef])
143
+
144
+ useFocusZone({
145
+ containerRef: overlayRef,
146
+ disabled: !open || !position,
147
+ ...focusZoneSettings
148
+ })
149
+ useFocusTrap({containerRef: overlayRef, disabled: !open || !position, ...focusTrapSettings})
150
+
151
+ return (
152
+ <>
153
+ {renderAnchor &&
154
+ renderAnchor({
155
+ ref: anchorRef,
156
+ id: anchorId,
157
+ 'aria-labelledby': anchorId,
158
+ 'aria-haspopup': 'true',
159
+ tabIndex: 0,
160
+ onClick: onAnchorClick,
161
+ onKeyDown: onAnchorKeyDown
162
+ })}
163
+ {open ? (
164
+ <Overlay
165
+ returnFocusRef={anchorRef}
166
+ onClickOutside={onClickOutside}
167
+ ignoreClickRefs={[anchorRef]}
168
+ onEscape={onEscape}
169
+ ref={updateOverlayRef}
170
+ role="none"
171
+ visibility={position ? 'visible' : 'hidden'}
172
+ height={height}
173
+ width={width}
174
+ top={position?.top || 0}
175
+ left={position?.left || 0}
176
+ anchorSide={position?.anchorSide}
177
+ {...overlayProps}
178
+ >
179
+ {children}
180
+ </Overlay>
181
+ ) : null}
182
+ </>
183
+ )
184
+ }
185
+
186
+ AnchoredOverlay.displayName = 'AnchoredOverlay'
187
+
188
+ AnchoredOverlay.defaultProps = {
189
+ side: 'outside-bottom',
190
+ align: 'start'
191
+ }
@@ -0,0 +1,2 @@
1
+ export {AnchoredOverlay} from './AnchoredOverlay'
2
+ export type {AnchoredOverlayProps} from './AnchoredOverlay'
@@ -0,0 +1,103 @@
1
+ import React, {useCallback, useReducer, useRef} from 'react'
2
+ import {useSSRSafeId} from '@react-aria/ssr'
3
+ import {ComponentProps} from '../utils/types'
4
+ import {AutocompleteContext} from './AutocompleteContext'
5
+ import AutocompleteInput from './AutocompleteInput'
6
+ import AutocompleteMenu from './AutocompleteMenu'
7
+ import AutocompleteOverlay from './AutocompleteOverlay'
8
+
9
+ type Action =
10
+ | {type: 'showMenu' | 'isMenuDirectlyActivated'; payload: boolean}
11
+ | {type: 'autocompleteSuggestion' | 'inputValue'; payload: string}
12
+ | {type: 'selectedItemLength'; payload: number}
13
+
14
+ interface State {
15
+ inputValue: string
16
+ showMenu: boolean
17
+ isMenuDirectlyActivated: boolean
18
+ autocompleteSuggestion: string
19
+ selectedItemLength: number
20
+ }
21
+
22
+ const initialState = {
23
+ inputValue: '',
24
+ showMenu: false,
25
+ isMenuDirectlyActivated: false,
26
+ autocompleteSuggestion: '',
27
+ selectedItemLength: 0
28
+ }
29
+
30
+ const reducer = (state: State, action: Action) => {
31
+ const {type, payload} = action
32
+ switch (type) {
33
+ case 'inputValue':
34
+ return {...state, inputValue: payload as State['inputValue']}
35
+ case 'showMenu':
36
+ return {...state, showMenu: payload as State['showMenu']}
37
+ case 'isMenuDirectlyActivated':
38
+ return {...state, isMenuDirectlyActivated: payload as State['isMenuDirectlyActivated']}
39
+ case 'autocompleteSuggestion':
40
+ return {...state, autocompleteSuggestion: payload as State['autocompleteSuggestion']}
41
+ case 'selectedItemLength':
42
+ return {...state, selectedItemLength: payload as State['selectedItemLength']}
43
+ default:
44
+ return state
45
+ }
46
+ }
47
+
48
+ const Autocomplete: React.FC<{id?: string}> = ({children, id: idProp}) => {
49
+ const activeDescendantRef = useRef<HTMLElement>(null)
50
+ const scrollContainerRef = useRef<HTMLDivElement>(null)
51
+ const inputRef = useRef<HTMLInputElement>(null)
52
+ const [state, dispatch] = useReducer(reducer, initialState)
53
+ const {inputValue, showMenu, autocompleteSuggestion, isMenuDirectlyActivated, selectedItemLength} = state
54
+ const setInputValue = useCallback((value: State['inputValue']) => {
55
+ dispatch({type: 'inputValue', payload: value})
56
+ }, [])
57
+ const setShowMenu = useCallback((value: State['showMenu']) => {
58
+ dispatch({type: 'showMenu', payload: value})
59
+ }, [])
60
+ const setAutocompleteSuggestion = useCallback((value: State['autocompleteSuggestion']) => {
61
+ dispatch({type: 'autocompleteSuggestion', payload: value})
62
+ }, [])
63
+ const setIsMenuDirectlyActivated = useCallback((value: State['isMenuDirectlyActivated']) => {
64
+ dispatch({type: 'isMenuDirectlyActivated', payload: value})
65
+ }, [])
66
+ const setSelectedItemLength = useCallback((value: State['selectedItemLength']) => {
67
+ dispatch({type: 'selectedItemLength', payload: value})
68
+ }, [])
69
+ const id = useSSRSafeId(idProp)
70
+
71
+ return (
72
+ <AutocompleteContext.Provider
73
+ value={{
74
+ activeDescendantRef,
75
+ autocompleteSuggestion,
76
+ id,
77
+ inputRef,
78
+ inputValue,
79
+ isMenuDirectlyActivated,
80
+ scrollContainerRef,
81
+ selectedItemLength,
82
+ setAutocompleteSuggestion,
83
+ setInputValue,
84
+ setIsMenuDirectlyActivated,
85
+ setShowMenu,
86
+ setSelectedItemLength,
87
+ showMenu
88
+ }}
89
+ >
90
+ {children}
91
+ </AutocompleteContext.Provider>
92
+ )
93
+ }
94
+
95
+ export type AutocompleteProps = ComponentProps<typeof Autocomplete>
96
+ export type {AutocompleteInputProps} from './AutocompleteInput'
97
+ export type {AutocompleteMenuProps} from './AutocompleteMenu'
98
+ export type {AutocompleteOverlayProps} from './AutocompleteOverlay'
99
+ export default Object.assign(Autocomplete, {
100
+ Input: AutocompleteInput,
101
+ Menu: AutocompleteMenu,
102
+ Overlay: AutocompleteOverlay
103
+ })