Merge branch 'main' into siddharthkp/migration-adr

siddharthkp · web-flow · commit f1396e2c165c · 2022-06-20T10:52:42.000+02:00
diff --git a/.changeset/proud-colts-attend.md b/.changeset/proud-colts-attend.md
@@ -0,0 +1,5 @@
+---
+"@primer/react": patch
+---
+
+Allow minor version updates for production dependencies
diff --git a/.changeset/stale-hounds-notice.md b/.changeset/stale-hounds-notice.md
@@ -0,0 +1,9 @@
+---
+"@primer/react": minor
+---
+
+[NavList](https://primer.style/NavList) is ready to use. You can now import it from the main bundle:
+
+```js
+import {NavList} from '@primer/react'
+```
diff --git a/.github/workflows/deploy_preview.yml b/.github/workflows/deploy_preview.yml
@@ -13,7 +13,7 @@ jobs:
     name: Preview
     uses: primer/.github/.github/workflows/deploy_preview.yml@main
     with:
-      node_version: 16
+      node_version: 14
       install: npm ci && cd docs && npm ci && cd ..
       build: npm run build:docs:preview
       output_dir: docs/public
diff --git a/.github/workflows/deploy_production.yml b/.github/workflows/deploy_production.yml
@@ -38,7 +38,7 @@ jobs:
     if: ${{ needs.guard.outputs.should_deploy == 'true' }}
     uses: primer/.github/.github/workflows/deploy.yml@main
     with:
-      node_version: 16
+      node_version: 14
       install: npm ci && cd docs && npm ci && cd ..
       build: npm run build:docs
       output_dir: docs/public
diff --git a/docs/content/NavList.mdx b/docs/content/NavList.mdx
@@ -1,12 +1,14 @@
 ---
 title: NavList
-status: Draft
-description: Use nav list to render a vertical list of navigation links.
+status: Alpha
+componentId: nav_list
+description: Use a nav list to render a vertical list of navigation links.
 source: https://github.com/primer/react/tree/main/src/NavList
+storybook: '/react/storybook/?path=/story/composite-components-navlist--simple'
 ---
 
 ```js
-import {NavList} from '@primer/react/drafts'
+import {NavList} from '@primer/react'
 ```
 
 ## Examples
@@ -333,9 +335,9 @@ function App() {
     adaptsToThemes: true,
     adaptsToScreenSizes: true,
     fullTestCoverage: true,
-    usedInProduction: false,
+    usedInProduction: true,
     usageExamplesDocumented: true,
-    hasStorybookStories: false,
+    hasStorybookStories: true,
     designReviewed: false,
     a11yReviewed: false,
     stableApi: false,
diff --git a/docs/src/@primer/gatsby-theme-doctocat/nav.yml b/docs/src/@primer/gatsby-theme-doctocat/nav.yml
@@ -90,6 +90,8 @@
       url: /LabelGroup
     - title: Link
       url: /Link
+    - title: NavList
+      url: /NavList
     - title: Overlay
       url: /Overlay
     - title: Pagehead
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -78,24 +78,24 @@
     "npm": ">=7"
   },
   "dependencies": {
-    "@primer/behaviors": "1.1.1",
-    "@primer/octicons-react": "16.1.1",
-    "@primer/primitives": "7.6.0",
-    "@radix-ui/react-polymorphic": "0.0.14",
-    "@react-aria/ssr": "3.1.0",
-    "@styled-system/css": "5.1.5",
-    "@styled-system/props": "5.1.5",
-    "@styled-system/theme-get": "5.1.2",
-    "@types/styled-components": "5.1.11",
-    "@types/styled-system": "5.1.12",
-    "@types/styled-system__css": "5.0.16",
-    "@types/styled-system__theme-get": "5.0.1",
-    "classnames": "2.3.1",
-    "color2k": "1.2.4",
-    "deepmerge": "4.2.2",
-    "focus-visible": "5.2.0",
-    "history": "5.0.0",
-    "styled-system": "5.1.5"
+    "@primer/behaviors": "^1.1.1",
+    "@primer/octicons-react": "^17.3.0",
+    "@primer/primitives": "^7.6.0",
+    "@radix-ui/react-polymorphic": "^0.0.14",
+    "@react-aria/ssr": "^3.1.0",
+    "@styled-system/css": "^5.1.5",
+    "@styled-system/props": "^5.1.5",
+    "@styled-system/theme-get": "^5.1.2",
+    "@types/styled-components": "^5.1.11",
+    "@types/styled-system": "^5.1.12",
+    "@types/styled-system__css": "^5.0.16",
+    "@types/styled-system__theme-get": "^5.0.1",
+    "classnames": "^2.3.1",
+    "color2k": "^1.2.4",
+    "deepmerge": "^4.2.2",
+    "focus-visible": "^5.2.0",
+    "history": "^5.0.0",
+    "styled-system": "^5.1.5"
   },
   "devDependencies": {
     "@babel/cli": "7.17.6",
diff --git a/src/ActionList/Divider.tsx b/src/ActionList/Divider.tsx
@@ -4,11 +4,12 @@ import {get} from '../constants'
 import {Theme} from '../ThemeProvider'
 import {SxProp, merge} from '../sx'
 
+export type ActionListDividerProps = SxProp
+
 /**
  * Visually separates `Item`s or `Group`s in an `ActionList`.
  */
-
-export const Divider: React.FC<SxProp> = ({sx = {}}) => {
+export const Divider: React.FC<ActionListDividerProps> = ({sx = {}}) => {
   return (
     <Box
       as="li"
diff --git a/src/ActionList/index.ts b/src/ActionList/index.ts
@@ -10,6 +10,7 @@ export type {ActionListProps} from './List'
 export type {ActionListGroupProps} from './Group'
 export type {ActionListItemProps} from './Item'
 export type {ActionListLinkItemProps} from './LinkItem'
+export type {ActionListDividerProps} from './Divider'
 export type {ActionListDescriptionProps} from './Description'
 export type {ActionListLeadingVisualProps, ActionListTrailingVisualProps} from './Visuals'
 
diff --git a/src/NavList/NavList.tsx b/src/NavList/NavList.tsx
@@ -3,7 +3,12 @@ import {ForwardRefComponent as PolymorphicForwardRefComponent} from '@radix-ui/r
 import {useSSRSafeId} from '@react-aria/ssr'
 import React, {isValidElement} from 'react'
 import styled from 'styled-components'
-import {ActionList} from '../ActionList'
+import {
+  ActionList,
+  ActionListDividerProps,
+  ActionListLeadingVisualProps,
+  ActionListTrailingVisualProps
+} from '../ActionList'
 import Box from '../Box'
 import StyledOcticon from '../StyledOcticon'
 import sx, {merge, SxProp} from '../sx'
@@ -154,7 +159,7 @@ function ItemWithSubNav({children, subNav, sx: sxProp = {}}: ItemWithSubNavProps
 // ----------------------------------------------------------------------------
 // NavList.SubNav
 
-type NavListSubNavProps = {
+export type NavListSubNavProps = {
   children: React.ReactNode
 } & SxProp
 
@@ -203,28 +208,34 @@ SubNav.displayName = 'NavList.SubNav'
 // ----------------------------------------------------------------------------
 // NavList.LeadingVisual
 
+export type NavListLeadingVisualProps = ActionListLeadingVisualProps
+
 const LeadingVisual = ActionList.LeadingVisual
 
 LeadingVisual.displayName = 'NavList.LeadingVisual'
 
 // ----------------------------------------------------------------------------
 // NavList.TrailingVisual
 
+export type NavListTrailingVisualProps = ActionListTrailingVisualProps
+
 const TrailingVisual = ActionList.TrailingVisual
 
 TrailingVisual.displayName = 'NavList.TrailingVisual'
 
 // ----------------------------------------------------------------------------
 // NavList.Divider
 
+export type NavListDividerProps = ActionListDividerProps
+
 const Divider = ActionList.Divider
 
 Divider.displayName = 'NavList.Divider'
 
 // ----------------------------------------------------------------------------
 // NavList.Group
 
-type NavListGroupProps = {
+export type NavListGroupProps = {
   children: React.ReactNode
   title?: string
 } & SxProp
diff --git a/src/__tests__/lockfile-version.test.ts b/src/__tests__/lockfile-version.test.ts
@@ -0,0 +1,10 @@
+import lockFile from '../../package-lock.json'
+import docsLockFile from '../../docs/package-lock.json'
+
+test('root: lockfileVersion should be 2', async () => {
+  expect(lockFile.lockfileVersion).toEqual(2)
+})
+
+test('docs: lockfileVersion should be 2', async () => {
+  expect(docsLockFile.lockfileVersion).toEqual(2)
+})
diff --git a/src/index.ts b/src/index.ts
@@ -41,6 +41,7 @@ export type {
   ActionListGroupProps,
   ActionListItemProps,
   ActionListLinkItemProps,
+  ActionListDividerProps,
   ActionListDescriptionProps,
   ActionListLeadingVisualProps,
   ActionListTrailingVisualProps
@@ -95,6 +96,16 @@ export {default as LabelGroup} from './LabelGroup'
 export type {LabelGroupProps} from './LabelGroup'
 export {default as Link} from './Link'
 export type {LinkProps} from './Link'
+export {NavList} from './NavList'
+export type {
+  NavListProps,
+  NavListItemProps,
+  NavListSubNavProps,
+  NavListGroupProps,
+  NavListLeadingVisualProps,
+  NavListTrailingVisualProps,
+  NavListDividerProps
+} from './NavList'
 export {default as Overlay} from './Overlay'
 export type {OverlayProps} from './Overlay'
 export {default as Pagehead} from './Pagehead'
diff --git a/tsconfig.json b/tsconfig.json
@@ -13,6 +13,7 @@
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
     "typeRoots": ["./node_modules/@types", "./@types"]
   },
   "include": ["@types/**/*.ts", "src/**/*.js", "src/**/*.ts", "src/**/*.tsx", "script/**/*.ts"]

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@primer/react": patch
 +---
++
 +Allow minor version updates for production dependencies