Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Popover no longer accepts styled system props #1570

Merged
merged 1 commit into from
Nov 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gentle-birds-cough.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/components': major
---

Popover no longer accepts styled-system props. Please use the `sx` prop to extend Primer component styling instead. See also https://primer.style/react/overriding-styles for information about `sx` and https://primer.style/react/system-props for context on the removal.
30 changes: 11 additions & 19 deletions docs/content/Popover.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,33 +105,25 @@ function CaretSelector(props) {
render(<PopoverDemo />)
```

## System props

<Note variant="warning">

System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.

</Note>

ProgressBar components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.

## Component props

### Popover

| Name | Type | Default | Description |
| :------- | :------ | :-----: | :----------------------------------------------------------------------------- |
| as | String | 'div' | Sets the HTML tag for the component. |
| caret | String | 'top' | Controls the position of the caret. See below for the list of caret positions. |
| open | Boolean | false | Controls the visibility of the popover. |
| relative | Boolean | false | Set to true to render the popover using relative positioning. |
| Name | Type | Default | Description |
| :------- | :---------------- | :-----: | :----------------------------------------------------------------------------- |
| as | String | 'div' | Sets the HTML tag for the component. |
| caret | String | 'top' | Controls the position of the caret. See below for the list of caret positions. |
| open | Boolean | false | Controls the visibility of the popover. |
| relative | Boolean | false | Set to true to render the popover using relative positioning. |
| sx | SystemStyleObject | {} | Style to be applied to the component |

#### Caret Positions

The `caret` prop can be one of the following values: `top`, `bottom`, `left`, `right`, `bottom-left`, `bottom-right`, `top-left`, `top-right`, `left-bottom`, `left-top`, `right-bottom`, or `right-top`.

### Popover.Content

| Name | Type | Default | Description |
| :--- | :----- | :-----: | :----------------------------------- |
| as | String | 'div' | Sets the HTML tag for the component. |
| Name | Type | Default | Description |
| :--- | :---------------- | :-----: | :----------------------------------- |
| as | String | 'div' | Sets the HTML tag for the component. |
| sx | SystemStyleObject | {} | Style to be applied to the component |
17 changes: 3 additions & 14 deletions src/Popover.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import classnames from 'classnames'
import styled from 'styled-components'
import Box from './Box'
import {COMMON, get, LAYOUT, POSITION, SystemCommonProps, SystemLayoutProps, SystemPositionProps} from './constants'
import {get} from './constants'
import sx, {SxProp} from './sx'
import {ComponentProps} from './utils/types'

Expand All @@ -23,10 +22,7 @@ type StyledPopoverProps = {
caret?: CaretPosition
relative?: boolean
open?: boolean
} & SystemCommonProps &
SystemLayoutProps &
SystemPositionProps &
SxProp
} & SxProp

const Popover = styled.div.attrs<StyledPopoverProps>(({className, caret}) => {
return {
Expand All @@ -36,14 +32,10 @@ const Popover = styled.div.attrs<StyledPopoverProps>(({className, caret}) => {
position: ${props => (props.relative ? 'relative' : 'absolute')};
z-index: 100;
display: ${props => (props.open ? 'block' : 'none')};

${COMMON};
${LAYOUT};
${POSITION};
${sx};
`

const PopoverContent = styled(Box)`
const PopoverContent = styled.div<SxProp>`
border: 1px solid ${get('colors.border.default')};
border-radius: ${get('radii.2')};
position: relative;
Expand All @@ -53,9 +45,6 @@ const PopoverContent = styled(Box)`
padding: ${get('space.4')};
background-color: ${get('colors.canvas.overlay')};

${COMMON};
${LAYOUT};

// Carets
&::before,
&::after {
Expand Down
17 changes: 17 additions & 0 deletions src/__tests__/Popover.types.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import React from 'react'
import Popover from '../Popover'

export function shouldAcceptCallWithNoProps() {
return <Popover />
}

export function shouldNotAcceptSystemProps() {
return (
<>
{/* @ts-expect-error system props should not be accepted */}
<Popover backgroundColor="palegreen" />
{/* @ts-expect-error system props should not be accepted */}
<Popover.Content backgroundColor="paleturquoise" />
</>
)
}