@primer/components 32.0.1 → 32.0.2-rc.859381a1

package/docs/content/AvatarStack.mdx

@@ -0,0 +1,37 @@
+---
+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
+
+```jsx live
+<AvatarStack>
+  <Avatar alt="Primer" src="https://avatars.githubusercontent.com/primer" />
+  <Avatar alt="GitHub" src="https://avatars.githubusercontent.com/github" />
+  <Avatar alt="Atom" src="https://avatars.githubusercontent.com/atom" />
+  <Avatar alt="Desktop" src="https://avatars.githubusercontent.com/desktop" />
+</AvatarStack>
+```
+
+### Right aligned
+
+```jsx live
+<AvatarStack alignRight>
+  <Avatar alt="Primer" src="https://avatars.githubusercontent.com/primer" />
+  <Avatar alt="GitHub" src="https://avatars.githubusercontent.com/github" />
+  <Avatar alt="Atom" src="https://avatars.githubusercontent.com/atom" />
+  <Avatar alt="Desktop" src="https://avatars.githubusercontent.com/desktop" />
+</AvatarStack>
+```
+
+## Props
+
+| Name       | Type              | Default | Description                          |
+| :--------- | :---------------- | :-----: | :----------------------------------- |
+| alignRight | Boolean           |         | Creates right aligned AvatarStack    |
+| sx         | SystemStyleObject |   {}    | Style to be applied to the component |

package/docs/content/BorderBox.md

@@ -0,0 +1,46 @@
+---
+title: BorderBox
+status: Deprecated
+---
+
+BorderBox is a Box component with a border. When no `borderColor` is present, the component defaults to a primary border.
+
+## Deprecation
+
+Use [Box](/Box) instead.
+
+**Before**
+
+```jsx
+<BorderBox>Item 1</BorderBox>
+```
+
+**After**
+
+```jsx
+<Box borderWidth="1px" borderStyle="solid" borderColor="border.default" borderRadius={2}>
+  Item 1
+</Box>
+```
+
+## Default example
+
+```jsx live
+<BorderBox>This is a BorderBox</BorderBox>
+```
+
+Note that `BorderBox` has default props set for `borderWidth`, `borderStyle`, and `borderColor`. This means that you cannot use `border={0} borderBottom={1}` or similar patterns; instead, use individual properties like `borderWidth={0} borderBottomWidth={1}`.
+
+## System props
+
+BorderBox components get `COMMON`, `LAYOUT`, `BORDER`, and `FLEX` system props. Read our [System Props](/system-props) doc page for a full list of available props.
+
+## Component props
+
+| Prop name    | Type             |            Default            | Description                                                   |
+| :----------- | :--------------- | :---------------------------: | :------------------------------------------------------------ |
+| borderWidth  | String           |             '1px'             | Sets the border, use theme values or provide your own.        |
+| borderStyle  | String           |            'solid'            | Sets the border style, use theme values or provide your own.  |
+| borderColor  | String           | 'border.primary' (from theme) | Sets the border color, use theme values or provide your own.  |
+| borderRadius | String or Number |        2 (from theme)         | Sets the border radius, use theme values or provide your own. |
+| boxShadow    | String           |                               | Sets box shadow, use theme values or provide your own.        |

package/docs/content/Box.mdx

@@ -0,0 +1,96 @@
+---
+title: Box
+status: Beta
+description: A low-level utility component that accepts styled system props to enable custom theme-aware styling
+source: https://github.com/primer/react/blob/main/src/Box.tsx
+---
+
+import {Props} from '../src/props'
+import {ComponentChecklist} from '../src/component-checklist'
+import {Box} from '@primer/components'
+
+```jsx live
+<Box color="fg.muted" bg="canvas.subtle" p={3}>
+  Hello
+</Box>
+```
+
+## Props
+
+<Props of={Box} />
+
+Box also accepts all [styled system props](https://styled-system.com/table/).
+
+## Examples
+
+### Border on all sides
+
+```jsx live
+<Box borderColor="border.default" borderWidth={1} borderStyle="solid" p={3}>
+  Hello
+</Box>
+```
+
+### Border on one side
+
+```jsx live
+<Box borderColor="border.default" borderBottomWidth={1} borderBottomStyle="solid" pb={3}>
+  Hello
+</Box>
+```
+
+### Flexbox
+
+Use Box to create [flexbox](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Flexbox) layouts.
+
+```jsx live
+<Box display="flex">
+  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
+    1
+  </Box>
+  <Box flexGrow={1} p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
+    2
+  </Box>
+  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
+    3
+  </Box>
+</Box>
+```
+
+### Grid
+
+Use Box to create [grid](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Grids) layouts.
+
+```jsx live
+<Box display="grid" gridTemplateColumns="1fr 1fr" gridGap={3}>
+  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
+    1
+  </Box>
+  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
+    2
+  </Box>
+  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
+    3
+  </Box>
+</Box>
+```
+
+## Component status
+
+<ComponentChecklist
+  items={{
+    propsDocumented: true,
+    noUnnecessaryDeps: true,
+    adaptsToThemes: true,
+    adaptsToScreenSizes: true,
+    fullTestCoverage: true,
+    usedInProduction: true,
+    usageExamplesDocumented: true,
+    designReviewed: null,
+    a11yReviewed: null,
+    stableApi: false,
+    addressedApiFeedback: false,
+    hasDesignGuidelines: null,
+    hasFigmaComponent: null
+  }}
+/>

package/docs/content/BranchName.md

@@ -0,0 +1,18 @@
+---
+title: BranchName
+---
+
+BranchName is a label-type component rendered as an `<a>` tag by default with monospace font.
+
+## Default example
+
+```jsx live live
+<BranchName>a_new_feature_branch</BranchName>
+```
+
+## Component props
+
+| Name | Type   | Default | Description                         |
+| :--- | :----- | :-----: | :---------------------------------- |
+| as   | String |  `<a>`  | sets the HTML tag for the component |
+| href | String |         | a URL to link the component to      |

package/docs/content/Breadcrumbs.md

@@ -0,0 +1,47 @@
+---
+title: Breadcrumbs
+status: Alpha
+source: https://github.com/primer/react/blob/main/src/Breadcrumbs.tsx
+---
+
+Breadcrumbs are used to show taxonomical context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages. Breadcrumbs are most appropriate on pages that:
+
+- Are many levels deep on a site
+- Do not have a section-level navigation
+- May need the ability to quickly go back to the previous (parent) page
+
+To use Breadcrumbs with [react-router](https://github.com/ReactTraining/react-router) or
+[react-router-dom](https://www.npmjs.com/package/react-router-dom), pass
+`as={NavLink}` and omit the `selected` prop.
+This ensures that the NavLink gets `activeClassName='selected'`
+
+## Default example
+
+```jsx live
+<Breadcrumbs>
+  <Breadcrumbs.Item href="/">Home</Breadcrumbs.Item>
+  <Breadcrumbs.Item href="/about">About</Breadcrumbs.Item>
+  <Breadcrumbs.Item href="/about/team" selected>
+    Team
+  </Breadcrumbs.Item>
+</Breadcrumbs>
+```
+
+## Component props
+
+### Breadcrumbs
+
+| Prop name | Type              | Default | Description                          |
+| :-------- | :---------------- | :-----: | :----------------------------------- |
+| children  | ReactNode         |         | The `Breadcrumbs.Item`s              |
+| className | string            |         |                                      |
+| sx        | SystemStyleObject |  `{}`   | Style to be applied to the component |
+
+### Breadcrumbs.Item
+
+| Prop name | Type              | Default | Description                                      |
+| :-------- | :---------------- | :-----: | :----------------------------------------------- |
+| as        | string            |   `a`   | Sets the HTML tag for the component              |
+| href      | string            |         | URL to be used for the Link                      |
+| selected  | boolean           | `false` | Used to style the link as selected or unselected |
+| sx        | SystemStyleObject |  `{}`   | Style to be applied to the component             |

package/docs/content/Buttons.md

@@ -0,0 +1,46 @@
+---
+title: Buttons
+---
+
+`Button` is used for actions, like in forms, while `Link` is used for destinations, or moving from one page to another.
+
+In special cases where you'd like to use a `<a>` styled like a Button, use `<Button as='a'>` and provide an `href`.
+
+To create a button group, wrap `Button` elements in the `ButtonGroup` element. `ButtonGroup` gets the same props as `Box`.
+
+## Default examples
+
+```jsx live
+<>
+  <Button>Button</Button>
+  <ButtonDanger>Button Danger</ButtonDanger>
+  <ButtonOutline>Button Outline</ButtonOutline>
+  <ButtonPrimary>Button Primary</ButtonPrimary>
+  <ButtonInvisible>Button Invisible</ButtonInvisible>
+  <ButtonClose onClick={() => window.alert('button clicked')} />
+
+  <ButtonGroup display="block" my={2}>
+    <Button>Button</Button>
+    <Button>Button</Button>
+    <Button>Button</Button>
+  </ButtonGroup>
+
+  <ButtonTableList>Button Table List </ButtonTableList>
+</>
+```
+
+## Component props
+
+Native `<button>` HTML attributes are forwarded to the underlying React `button` component and are not listed below.
+
+### Button
+
+| Prop name | Type              | Default  | Description                                                                                                                 |
+| :-------- | :---------------- | :------: | :-------------------------------------------------------------------------------------------------------------------------- |
+| as        | String            | `button` | sets the HTML tag for the component                                                                                         |
+| sx        | SystemStyleObject |    {}    | Additional styles                                                                                                           |
+| variant   | String            | 'medium' | a value of `small`, `medium`, or `large` results in smaller or larger Button text size; no effect if `fontSize` prop is set |
+
+### ButtonGroup
+
+`ButtonGroup` has access to the same props as `Box`

package/docs/content/CircleBadge.md

@@ -0,0 +1,35 @@
+---
+title: CircleBadge
+---
+
+Use CircleBadge to visually connect logos of third party services like in marketplace. Use CircleBadge.Icon to add an Octicon to the CircleBadge.
+
+## Default example
+
+```jsx live
+<CircleBadge>
+  <CircleBadge.Icon icon={ZapIcon} />
+</CircleBadge>
+```
+
+## Component props
+
+### CircleBadge
+
+| Name    | Type    | Default  | Description                                                                                                 |
+| :------ | :------ | :------: | :---------------------------------------------------------------------------------------------------------- |
+| as      | String  |  `div`   | sets the HTML tag for the component                                                                         |
+| inline  | Boolean |  false   | Styles the badge to display inline                                                                          |
+| size    | Number  |          | sets the size of the badge in pixels; overrides any value for `variant` prop when set                       |
+| variant | String  | 'medium' | a value of `small`, `medium`, or `large` creates a smaller or larger badge; no effect if `size` prop is set |
+
+### CircleBadge.Icon
+
+CircleBadge.Icon components receive all the same props at [StyledOcticon]. They are listed below for convenience:
+
+| Name          | Type      |    Default    | Description                                                                                                  |
+| :------------ | :-------- | :-----------: | :----------------------------------------------------------------------------------------------------------- |
+| ariaLabel     | String    |               | Specifies the `aria-label` attribute, which is read verbatim by screen readers                               |
+| icon          | Component |               | [Octicon component](https://github.com/primer/octicons/tree/master/lib/octicons_react) used in the component |
+| size          | Number    |      16       | Sets the uniform `width` and `height` of the SVG element                                                     |
+| verticalAlign | String    | `text-bottom` | Sets the `vertical-align` CSS property                                                                       |

package/docs/content/CircleOcticon.md

@@ -0,0 +1,18 @@
+---
+title: CircleOcticon
+---
+
+CircleOcticon renders any Octicon with a circle background. CircleOcticons are most commonly used to represent the status of a pull request in the comment timeline.
+
+## Default example
+
+```jsx live
+<CircleOcticon icon={CheckIcon} size={32} sx={{bg: "success.fg", color: "fg.onEmphasis"}} />
+```
+
+## Component props
+
+| Name | Type    | Default | Description                                       |
+| :--- | :------ | :-----: | :------------------------------------------------ |
+| icon | Octicon |         | Octicon component used in the component           |
+| size | Number  |   32    | used to set the width and height of the component |

package/docs/content/CounterLabel.md

@@ -0,0 +1,22 @@
+---
+title: CounterLabel
+tags: pill
+---
+
+Use the CounterLabel component to add a count to navigational elements and buttons.
+
+## Default example
+
+```jsx live
+<>
+  <CounterLabel>12</CounterLabel>
+  <CounterLabel scheme="primary">13</CounterLabel>
+  <CounterLabel scheme="secondary">13</CounterLabel>
+</>
+```
+
+## Component props
+
+| Name   | Type   | Default | Description                                                                                                                                                                        |
+| :----- | :----- | :-----: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| scheme | String |         | Pass in 'primary' for a darker background and inverse text, or 'gray-light' for a lighter background and primary text. Omitting the scheme prop renders the default counter scheme |

package/docs/content/Details.md

@@ -0,0 +1,105 @@
+---
+title: Details & useDetails hook
+---
+
+`Details` is a styled `details` element for use with the `useDetails` hook. The `useDetails` hook returns the `open` state, a `setOpen` function to manually change the open state, and **`getDetailsProps` which must be spread onto your `Details` element in order for `Details` to get receive the proper behaviors provided by the hook**. See Kent Dodd's article on this pattern [here](https://kentcdodds.com/blog/how-to-give-rendering-control-to-users-with-prop-getters).
+
+The `useDetails` hook also takes a few configuration options as parameters which are noted in the table below.
+
+You must use a `summary` element as your `Details` trigger button. To style your summary element like a [Button](./Button), you can use the `as` prop (see example below).
+
+It's also possible to use the `useDetails` hook with components other than the Primer `Details`, such as a custom `Details` or `Modal` wrapper in your consuming application. All that matters is that the outer element is a `details` and it contains a `summary` for the button that opens and closes the component, and that `getDetailsProps` is properly spread onto the component rendering your `details` element.
+
+```jsx live
+<State>
+  {([]) => {
+    const {getDetailsProps} = useDetails({closeOnOutsideClick: true})
+    return (
+      <Details {...getDetailsProps()}>
+        <Button as="summary">Hello</Button>
+        This is some content
+      </Details>
+    )
+  }}
+</State>
+```
+
+You can use the `open` state returned from the hook to conditionally render content:
+
+```jsx live
+<State>
+  {([]) => {
+    const {getDetailsProps, open} = useDetails({closeOnOutsideClick: true})
+    return (
+      <Details {...getDetailsProps()}>
+        <Button as="summary">{open ? 'open' : 'close'}</Button>
+        This is some content
+      </Details>
+    )
+  }}
+</State>
+```
+
+You can also manually show/hide the content using the `setOpen` function returned from the hook. This can be useful if you have action items in the content of the component such as confirmation buttons:
+
+```jsx live
+<State>
+  {([]) => {
+    const {getDetailsProps, setOpen} = useDetails({closeOnOutsideClick: true})
+    return (
+      <Details {...getDetailsProps()}>
+        <Button as="summary">Delete item</Button>
+        Are you sure?
+        <ButtonDanger onClick={() => setOpen(false)}>Yes I'm sure</ButtonDanger>
+      </Details>
+    )
+  }}
+</State>
+```
+
+In previous versions of Primer React Components, we allowed users to pass in a custom `onToggle` function. You can do this now by overriding the `onToggle` function returned in `getDetailsProps`. Please note that in most cases, you'll want the hook's handling of `onToggle` to be run as well, so that the internal state is properly updated. To do this, manually call the `onToggle` handler returned from `useDetails` before executing your custom `onToggle` code.
+
+```jsx live
+<State>
+  {([]) => {
+    const {getDetailsProps, open, setOpen} = useDetails({closeOnOutsideClick: true})
+    const {onToggle, ...detailsProps} = getDetailsProps()
+    const customToggle = e => {
+      onToggle(e)
+      window.alert('hi')
+    }
+    return (
+      <Details {...detailsProps} onToggle={customToggle}>
+        <Button as="summary">{open ? 'Open' : 'Closed'}</Button>
+        Hello World
+      </Details>
+    )
+  }}
+</State>
+```
+
+## `Details` System props
+
+<Note variant="warning">
+
+System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
+
+</Note>
+
+Details components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
+
+## `useDetails` hook configuration options
+
+| Name                | Type      | Default | Description                                                               |
+| :------------------ | :-------- | :-----: | :------------------------------------------------------------------------ |
+| defaultOpen         | Boolean   |         | Sets the initial open/closed state                                        |
+| closeOnOutsideClick | Boolean   |  false  | Sets whether or not element will close when the user clicks outside of it |
+| ref                 | React ref |         | optional ref to pass down to Details component                            |
+
+### Values returned by the `useDetails` hook
+
+| Name            | Type     | Description                                                                                                                                                                                                                              |
+| :-------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| open            | string   | Whether or not Details is currently open                                                                                                                                                                                                 |
+| setOpen         | function | Used to manually change the open state of the Details component                                                                                                                                                                          |
+| getDetailsProps | Object   | Contains an `onToggle` function, the `ref` to pass down to `Details` and the `open` attribute. In most cases, you won't need to interact with any of these values directly, but if you'd like to override any of these yourself you may. |

package/docs/content/Dialog.md

@@ -0,0 +1,105 @@
+---
+title: Dialog
+---
+
+import State from '../components/State'
+
+The dialog component is used for all modals. It renders on top of the rest of the app with an overlay.
+
+You'll need to manage the `isOpen` state in a wrapper component of your own and pass in a function to be used to close the Dialog. For documentation purposes only we've created a mock `State` to handle this, but you should handle the state in the component you consume `Dialog` in or in a wrapper component.
+
+### Accessibility
+
+A few considerations must be made to ensure your use of the `Dialog` component is accessible:
+
+- Always be sure to provide either `aria-labelledby` or `aria-label` to your `Dialog` component. In most cases you should use `aria-labelledby` and pass it the `id` of your `Dialog.Header`. If there is no text in your header, or you chose not to use a header, you can use `aria-label` to describe the purpose of the `Dialog`.
+
+- Be sure to pass a ref to return the focus back to once the `Dialog` closes via the `returnFocusRef` prop. In most cases this should be the element that opened the Dialog. If you decide to manage focus within your application and want to bypass Primer React Components from doing so when the `Dialog` closes, you can omit the `returnFocusProp`.
+
+### Z-index
+
+If you're running into z-index issues or are rendering the component inside of an absolutely positioned element, you can wrap your `Dialog` in a [React Portal](https://reactjs.org/docs/portals.html).
+
+### Examples
+
+```jsx live
+<State default={false}>
+  {([isOpen, setIsOpen]) => {
+    const returnFocusRef = React.useRef(null)
+    return (
+      <>
+        <Button ref={returnFocusRef} onClick={() => setIsOpen(true)}>
+          Open
+        </Button>
+        <Dialog
+          returnFocusRef={returnFocusRef}
+          isOpen={isOpen}
+          onDismiss={() => setIsOpen(false)}
+          aria-labelledby="header-id"
+        >
+          <Dialog.Header id="header-id">Title</Dialog.Header>
+          <Box p={3}>
+            <Text fontFamily="sans-serif">Some content</Text>
+          </Box>
+        </Dialog>
+      </>
+    )
+  }}
+</State>
+```
+
+You can also pass any non-text content into the header:
+
+```jsx live
+<State default={false}>
+  {([isOpen, setIsOpen]) => {
+    const returnFocusRef = React.useRef(null)
+    return (
+      <>
+        <Button ref={returnFocusRef} onClick={() => setIsOpen(true)}>
+          Open
+        </Button>
+        <Dialog
+          isOpen={isOpen}
+          returnFocusRef={returnFocusRef}
+          onDismiss={() => setIsOpen(false)}
+          aria-labelledby="label"
+        >
+          <Dialog.Header>
+            <ZapIcon />
+          </Dialog.Header>
+          <Box p={3}>
+            <Text id="label" fontFamily="sans-serif">
+              Are you sure you'd like to delete this issue?
+            </Text>
+            <Box display="flex" mt={3} justifyContent="flex-end">
+              <Button sx={{mr: 1}}>Cancel</Button>
+              <ButtonDanger>Delete</ButtonDanger>
+            </Box>
+          </Box>
+        </Dialog>
+      </>
+    )
+  }}
+</State>
+```
+
+## Component props
+
+### Dialog
+
+| Prop name       | Type              | Default | Description                                                                                                                                               |
+| :-------------- | :---------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| isOpen          | Boolean           |         | Set whether or not the dialog is shown                                                                                                                    |
+| onDismiss       | Function          |         | A user-provided function that should close the dialog                                                                                                     |
+| returnFocusRef  | React ref         |         | The element to restore focus back to after the `Dialog` is closed                                                                                         |
+| initialFocusRef | React ref         |         | Element inside of the `Dialog` you'd like to be focused when the Dialog is opened. If nothing is passed to `initialFocusRef` the close button is focused. |
+| aria-labelledby | string            |         | Pass an id to use for the aria-label. Use either a `aria-label` or an `aria-labelledby` but not both.                                                     |
+| aria-label      | string            |         | Pass a label to be used to describe the Dialog. Use either a `aria-label` or an `aria-labelledby` but not both.                                           |
+| sx              | SystemStyleObject | {}      | Style to be applied to the component                                                                                                                      |
+
+### Dialog.Header
+
+| Prop name | Type              | Default | Description                          |
+| :-------- | :---------------- | :------ | :----------------------------------- |
+| sx        | SystemStyleObject | {}      | Style to be applied to the component |