Merge branch 'main' into color-blind-themes

primer · Sep 28, 2021 · 56ed28a · 56ed28a
2 parents fd18dd1 + dc15763
commit 56ed28a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 23 deletions.
diff --git a/.changeset/selfish-deers-change.md b/.changeset/selfish-deers-change.md
@@ -0,0 +1,5 @@
+---
+'@primer/components': major
+---
+
+AvatarStack no longer accepts styled props or DOM props
diff --git a/docs/content/AvatarStack.mdx b/docs/content/AvatarStack.mdx
@@ -2,6 +2,9 @@
 title: AvatarStack
 ---
 
+import {Props} from '../src/props'
+import {AvatarStack} from '@primer/components'
+
 AvatarStack is used to display more than one Avatar in an inline stack.
 
 ### Default example
@@ -26,18 +29,9 @@ AvatarStack is used to display more than one Avatar in an inline stack.
 </AvatarStack>
 ```
 
-## System props
-
-<Note variant="warning">
-
-System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
-
-</Note>
-
-AvatarStack components get `COMMON` system props, AvatarStack.Item components do not get any system props. Read our [System Props](/system-props) doc page for a full list of available props.
-
-## AvatarStack Component props
+## Props
 
-| Name       | Type    | Default | Description                       |
-| :--------- | :------ | :-----: | :-------------------------------- |
-| alignRight | Boolean |         | Creates right aligned AvatarStack |
+| Name       | Type              | Default | Description                          |
+| :--------- | :---------------- | :-----: | :----------------------------------- |
+| alignRight | Boolean           |         | Creates right aligned AvatarStack    |
+| sx         | SystemStyleObject |   {}    | Style to be applied to the component |
diff --git a/src/AvatarStack.tsx b/src/AvatarStack.tsx
@@ -1,15 +1,13 @@
 import classnames from 'classnames'
 import React from 'react'
 import styled from 'styled-components'
-import {COMMON, get, SystemCommonProps} from './constants'
+import {get} from './constants'
 import {Box} from '.'
 import sx, {SxProp} from './sx'
-import {ComponentProps} from './utils/types'
 
 type StyledAvatarStackWrapperProps = {
   count?: number
-} & SystemCommonProps &
-  SxProp
+} & SxProp
 
 const AvatarStackWrapper = styled.span<StyledAvatarStackWrapperProps>`
   display: flex;
@@ -125,7 +123,6 @@ const AvatarStackWrapper = styled.span<StyledAvatarStackWrapperProps>`
     }
   }
 
-  ${COMMON}
   ${sx};
 `
 const transformChildren = (children: React.ReactNode) => {
@@ -140,17 +137,18 @@ const transformChildren = (children: React.ReactNode) => {
 
 export type AvatarStackProps = {
   alignRight?: boolean
-} & ComponentProps<typeof AvatarStackWrapper>
+  children: React.ReactNode
+} & SxProp
 
-const AvatarStack = ({children, alignRight, ...rest}: AvatarStackProps) => {
+const AvatarStack = ({children, alignRight, sx: sxProp}: AvatarStackProps) => {
   const count = React.Children.count(children)
   const wrapperClassNames = classnames({
     'pc-AvatarStack--two': count === 2,
     'pc-AvatarStack--three-plus': count > 2,
     'pc-AvatarStack--right': alignRight
   })
   return (
-    <AvatarStackWrapper count={count} className={wrapperClassNames} {...rest}>
+    <AvatarStackWrapper count={count} className={wrapperClassNames} sx={sxProp}>
       <Box position="absolute" display="flex" width="38px" className="pc-AvatarStackBody">
         {transformChildren(children)}
       </Box>

diff --git a/src/__tests__/AvatarStack.tsx b/src/__tests__/AvatarStack.tsx
@@ -25,7 +25,11 @@ const rightAvatarComp = (
 )
 
 describe('Avatar', () => {
-  behavesAsComponent({Component: AvatarStack, toRender: () => avatarComp})
+  behavesAsComponent({
+    Component: AvatarStack,
+    toRender: () => avatarComp,
+    options: {skipAs: true}
+  })
 
   checkExports('AvatarStack', {
     default: AvatarStack