@primer/components 32.1.1-rc.8eccc94b → 33.0.0-rc.42d465c3

package/src/ProgressBar.tsx

@@ -1,13 +1,15 @@
 import React from 'react'
 import styled from 'styled-components'
 import {width, WidthProps} from 'styled-system'
-import {COMMON, get, SystemCommonProps} from './constants'
+import {get} from './constants'
 import sx, {SxProp} from './sx'
-import {ComponentProps} from './utils/types'
 
-const Bar = styled.span<{progress?: string | number} & SystemCommonProps>`
+type ProgressProp = {progress?: string | number}
+
+const Bar = styled.span<ProgressProp & SxProp>`
   width: ${props => (props.progress ? `${props.progress}%` : 0)};
-  ${COMMON}
+
+  ${sx};
 `
 
 const sizeMap = {
@@ -20,7 +22,6 @@ type StyledProgressContainerProps = {
   inline?: boolean
   barSize?: keyof typeof sizeMap
 } & WidthProps &
-  SystemCommonProps &
   SxProp
 
 const ProgressContainer = styled.span<StyledProgressContainerProps>`
@@ -29,17 +30,17 @@ const ProgressContainer = styled.span<StyledProgressContainerProps>`
   background-color: ${get('colors.border.default')};
   border-radius: ${get('radii.1')};
   height: ${props => sizeMap[props.barSize || 'default']};
-  ${COMMON}
+
   ${width}
   ${sx};
 `
 
-export type ProgressBarProps = ComponentProps<typeof ProgressContainer> & ComponentProps<typeof Bar>
+export type ProgressBarProps = {bg: string} & StyledProgressContainerProps & ProgressProp
 
-function ProgressBar({progress, bg, theme, ...rest}: ProgressBarProps) {
+function ProgressBar({progress, bg, ...rest}: ProgressBarProps) {
   return (
-    <ProgressContainer theme={theme} {...rest}>
-      <Bar progress={progress} bg={bg} theme={theme} />
+    <ProgressContainer {...rest}>
+      <Bar progress={progress} sx={{bg}} />
     </ProgressContainer>
   )
 }

package/src/Spinner.tsx

@@ -1,6 +1,5 @@
 import React from 'react'
 import styled from 'styled-components'
-import {COMMON, SystemCommonProps} from './constants'
 import sx, {SxProp} from './sx'
 import {ComponentProps} from './utils/types'
 
@@ -40,7 +39,7 @@ function Spinner({size: sizeKey = 'medium', ...props}: SpinnerInternalProps) {
   )
 }
 
-const StyledSpinner = styled(Spinner)<SystemCommonProps & SxProp>`
+const StyledSpinner = styled(Spinner)<SxProp>`
   @keyframes rotate-keyframes {
     100% {
       transform: rotate(360deg);
@@ -49,7 +48,6 @@ const StyledSpinner = styled(Spinner)<SystemCommonProps & SxProp>`
 
   animation: rotate-keyframes 1s linear infinite;
 
-  ${COMMON}
   ${sx}
 `
 

package/src/ThemeProvider.tsx

@@ -24,6 +24,7 @@ const ThemeContext = React.createContext<{
   colorScheme?: string
   colorMode?: ColorModeWithAuto
   resolvedColorMode?: ColorMode
+  resolvedColorScheme?: string
   dayScheme?: string
   nightScheme?: string
   setColorMode: React.Dispatch<React.SetStateAction<ColorModeWithAuto>>
@@ -52,7 +53,10 @@ export const ThemeProvider: React.FC<ThemeProviderProps> = ({children, ...props}
   const systemColorMode = useSystemColorMode()
   const resolvedColorMode = resolveColorMode(colorMode, systemColorMode)
   const colorScheme = chooseColorScheme(resolvedColorMode, dayScheme, nightScheme)
-  const resolvedTheme = React.useMemo(() => applyColorScheme(theme, colorScheme), [theme, colorScheme])
+  const {resolvedTheme, resolvedColorScheme} = React.useMemo(
+    () => applyColorScheme(theme, colorScheme),
+    [theme, colorScheme]
+  )
 
   // Update state if props change
   React.useEffect(() => {
@@ -74,6 +78,7 @@ export const ThemeProvider: React.FC<ThemeProviderProps> = ({children, ...props}
         colorScheme,
         colorMode,
         resolvedColorMode,
+        resolvedColorScheme,
         dayScheme,
         nightScheme,
         setColorMode,
@@ -156,9 +161,15 @@ function chooseColorScheme(colorMode: ColorMode, dayScheme: string, nightScheme:
   }
 }
 
-function applyColorScheme(theme: Theme, colorScheme: string) {
+function applyColorScheme(
+  theme: Theme,
+  colorScheme: string
+): {resolvedTheme: Theme; resolvedColorScheme: string | undefined} {
   if (!theme.colorSchemes) {
-    return theme
+    return {
+      resolvedTheme: theme,
+      resolvedColorScheme: undefined
+    }
   }
 
   if (!theme.colorSchemes[colorScheme]) {
@@ -167,10 +178,16 @@ function applyColorScheme(theme: Theme, colorScheme: string) {
 
     // Apply the first defined color scheme
     const defaultColorScheme = Object.keys(theme.colorSchemes)[0]
-    return deepmerge(theme, theme.colorSchemes[defaultColorScheme])
+    return {
+      resolvedTheme: deepmerge(theme, theme.colorSchemes[defaultColorScheme]),
+      resolvedColorScheme: defaultColorScheme
+    }
   }
 
-  return deepmerge(theme, theme.colorSchemes[colorScheme])
+  return {
+    resolvedTheme: deepmerge(theme, theme.colorSchemes[colorScheme]),
+    resolvedColorScheme: colorScheme
+  }
 }
 
 export default ThemeProvider

package/src/__tests__/Avatar.test.tsx

@@ -39,6 +39,6 @@ describe('Avatar', () => {
   })
 
   it('respects margin props', () => {
-    expect(render(<Avatar m={2} src="primer.png" alt="" />)).toHaveStyleRule('margin', px(theme.space[2]))
+    expect(render(<Avatar src="primer.png" alt="" sx={{m: 2}} />)).toHaveStyleRule('margin', px(theme.space[2]))
   })
 })

package/src/__tests__/Avatar.types.test.tsx

@@ -0,0 +1,11 @@
+import React from 'react'
+import Avatar from '../Avatar'
+
+export function shouldAcceptCallWithNoProps() {
+  return <Avatar src="https://avatars.githubusercontent.com/primer" />
+}
+
+export function shouldNotAcceptSystemProps() {
+  // @ts-expect-error system props should not be accepted
+  return <Avatar src="https://avatars.githubusercontent.com/primer" backgroundColor="thistle" />
+}

package/src/__tests__/BranchName.types.test.tsx

@@ -0,0 +1,11 @@
+import React from 'react'
+import BranchName from '../BranchName'
+
+export function shouldAcceptCallWithNoProps() {
+  return <BranchName />
+}
+
+export function shouldNotAcceptSystemProps() {
+  // @ts-expect-error system props should not be accepted
+  return <BranchName backgroundColor="thistle" />
+}

package/src/__tests__/Details.types.test.tsx

@@ -0,0 +1,11 @@
+import React from 'react'
+import Details from '../Details'
+
+export function shouldAcceptCallWithNoProps() {
+  return <Details />
+}
+
+export function shouldNotAcceptSystemProps() {
+  // @ts-expect-error system props should not be accepted
+  return <Details backgroundColor="thistle" />
+}

package/src/__tests__/Heading.test.tsx

@@ -4,6 +4,7 @@ import {render, behavesAsComponent, checkExports} from '../utils/testing'
 import {render as HTMLRender, cleanup} from '@testing-library/react'
 import {axe, toHaveNoViolations} from 'jest-axe'
 import 'babel-polyfill'
+import ThemeProvider from '../ThemeProvider'
 expect.extend(toHaveNoViolations)
 
 const theme = {
@@ -48,44 +49,89 @@ describe('Heading', () => {
   })
 
   it('respects fontWeight', () => {
-    expect(render(<Heading fontWeight="bold" theme={theme} />)).toHaveStyleRule('font-weight', theme.fontWeights.bold)
-    expect(render(<Heading fontWeight="normal" theme={theme} />)).toHaveStyleRule(
-      'font-weight',
-      theme.fontWeights.normal
-    )
-    expect(render(<Heading fontWeight="semibold" theme={theme} />)).toHaveStyleRule(
-      'font-weight',
-      theme.fontWeights.semibold
-    )
-    expect(render(<Heading fontWeight="light" theme={theme} />)).toHaveStyleRule('font-weight', theme.fontWeights.light)
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{fontWeight: 'bold'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('font-weight', theme.fontWeights.bold)
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{fontWeight: 'normal'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('font-weight', theme.fontWeights.normal)
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{fontWeight: 'semibold'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('font-weight', theme.fontWeights.semibold)
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{fontWeight: 'light'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('font-weight', theme.fontWeights.light)
   })
 
   it('respects lineHeight', () => {
-    expect(render(<Heading lineHeight="normal" theme={theme} />)).toHaveStyleRule(
-      'line-height',
-      String(theme.lineHeights.normal)
-    )
-    expect(render(<Heading lineHeight="condensed" theme={theme} />)).toHaveStyleRule(
-      'line-height',
-      String(theme.lineHeights.condensed)
-    )
-    expect(render(<Heading lineHeight="condensedUltra" theme={theme} />)).toHaveStyleRule(
-      'line-height',
-      String(theme.lineHeights.condensedUltra)
-    )
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{lineHeight: 'normal'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('line-height', String(theme.lineHeights.normal))
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{lineHeight: 'condensed'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('line-height', String(theme.lineHeights.condensed))
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{lineHeight: 'condensedUltra'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('line-height', String(theme.lineHeights.condensedUltra))
   })
 
   it('respects fontFamily="mono"', () => {
-    expect(render(<Heading fontFamily="mono" theme={theme} />)).toHaveStyleRule('font-family', theme.fonts.mono)
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{fontFamily: 'mono'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('font-family', theme.fonts.mono)
   })
 
   it('renders fontSize', () => {
     for (const fontSize of theme.fontSizes) {
-      expect(render(<Heading fontSize={fontSize} theme={theme} />)).toHaveStyleRule('font-size', `${fontSize}`)
+      expect(
+        render(
+          <ThemeProvider theme={theme}>
+            <Heading sx={{fontSize}} />
+          </ThemeProvider>
+        )
+      ).toHaveStyleRule('font-size', `${fontSize}`)
     }
   })
 
   it('respects the "fontStyle" prop', () => {
-    expect(render(<Heading fontStyle="italic" />)).toHaveStyleRule('font-style', 'italic')
+    expect(
+      render(
+        <ThemeProvider theme={theme}>
+          <Heading sx={{fontStyle: 'italic'}} />
+        </ThemeProvider>
+      )
+    ).toHaveStyleRule('font-style', 'italic')
   })
 })

package/src/__tests__/Heading.types.test.tsx

@@ -0,0 +1,11 @@
+import React from 'react'
+import Heading from '../Heading'
+
+export function shouldAcceptCallWithNoProps() {
+  return <Heading />
+}
+
+export function shouldNotAcceptSystemProps() {
+  // @ts-expect-error system props should not be accepted
+  return <Heading backgroundColor="thistle" />
+}

package/src/__tests__/ThemeProvider.test.tsx

@@ -439,3 +439,119 @@ describe('useColorSchemeVar', () => {
     expect(screen.getByText('Hello')).toHaveStyleRule('background-color', 'blue')
   })
 })
+
+describe('useTheme().resolvedColorScheme', () => {
+  it('is undefined when not in a theme', () => {
+    const Component = () => {
+      const {resolvedColorScheme} = useTheme()
+
+      return <Text data-testid="text">{resolvedColorScheme}</Text>
+    }
+
+    render(<Component />)
+
+    expect(screen.getByTestId('text').textContent).toEqual('')
+  })
+
+  it('is undefined when the theme has no colorScheme object', () => {
+    const Component = () => {
+      const {resolvedColorScheme} = useTheme()
+
+      return <Text data-testid="text">{resolvedColorScheme}</Text>
+    }
+
+    render(
+      <ThemeProvider theme={{color: 'red'}}>
+        <Component />
+      </ThemeProvider>
+    )
+
+    expect(screen.getByTestId('text').textContent).toEqual('')
+  })
+
+  it('is the same as the applied colorScheme, when that colorScheme is in the theme', () => {
+    const Component = () => {
+      const {resolvedColorScheme} = useTheme()
+
+      return <Text data-testid="text">{resolvedColorScheme}</Text>
+    }
+
+    const schemeToApply = 'dark'
+
+    render(
+      <ThemeProvider theme={exampleTheme} colorMode="day" dayScheme={schemeToApply}>
+        <Component />
+      </ThemeProvider>
+    )
+
+    expect(exampleTheme.colorSchemes).toHaveProperty(schemeToApply)
+    expect(screen.getByTestId('text').textContent).toEqual(schemeToApply)
+  })
+
+  it('is the value of the fallback colorScheme applied when attempting to apply an invalid colorScheme', () => {
+    const Component = () => {
+      const {resolvedColorScheme} = useTheme()
+
+      return <Text data-testid="text">{resolvedColorScheme}</Text>
+    }
+
+    const schemeToApply = 'totally-invalid-colorscheme'
+    render(
+      <ThemeProvider theme={exampleTheme} colorMode="day" dayScheme={schemeToApply}>
+        <Component />
+      </ThemeProvider>
+    )
+
+    const defaultThemeColorScheme = Object.keys(exampleTheme.colorSchemes)[0]
+
+    expect(defaultThemeColorScheme).not.toEqual(schemeToApply)
+    expect(exampleTheme.colorSchemes).not.toHaveProperty(schemeToApply)
+    expect(screen.getByTestId('text').textContent).toEqual('light')
+  })
+
+  describe('nested theme', () => {
+    it('is the same as the applied colorScheme, when that colorScheme is in the theme', () => {
+      const Component = () => {
+        const {resolvedColorScheme} = useTheme()
+
+        return <Text data-testid="text">{resolvedColorScheme}</Text>
+      }
+
+      const schemeToApply = 'dark'
+
+      render(
+        <ThemeProvider theme={exampleTheme} colorMode="day" dayScheme={schemeToApply}>
+          <ThemeProvider>
+            <Component />
+          </ThemeProvider>
+        </ThemeProvider>
+      )
+
+      expect(exampleTheme.colorSchemes).toHaveProperty(schemeToApply)
+      expect(screen.getByTestId('text').textContent).toEqual(schemeToApply)
+    })
+
+    it('is the value of the fallback colorScheme applied when attempting to apply an invalid colorScheme', () => {
+      const Component = () => {
+        const {resolvedColorScheme} = useTheme()
+
+        return <Text data-testid="text">{resolvedColorScheme}</Text>
+      }
+
+      const schemeToApply = 'totally-invalid-colorscheme'
+      render(
+        <ThemeProvider theme={exampleTheme} colorMode="day" dayScheme={schemeToApply}>
+          <ThemeProvider>
+            <Component />
+          </ThemeProvider>
+        </ThemeProvider>
+      )
+
+      const defaultThemeColorScheme = Object.keys(exampleTheme.colorSchemes)[0]
+
+      expect(defaultThemeColorScheme).not.toEqual(schemeToApply)
+      expect(exampleTheme.colorSchemes).not.toHaveProperty(schemeToApply)
+      expect(screen.getByTestId('text').textContent).toEqual('light')
+    })
+  })
+})

package/src/drafts.ts

@@ -8,3 +8,4 @@
 // Components
 export * from './ActionList2'
 export * from './NewButton'
+export * from './ActionMenu2'