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

package/docs/content/Dialog2.mdx

@@ -0,0 +1,180 @@
+---
+title: Dialog v2
+---
+
+import State from '../components/State'
+
+The dialog component the Primer implementation of the ARIA design pattern [Dialog](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal). A dialog is a type of overlay that can be used for confirming actions, asking for disambiguation, and presenting small forms. They generally allow the user to focus on a quick task without having to navigate to a different page.
+
+**Dialogs appear in the page after a direct user interaction**. Don't show dialogs on page load or as system alerts.
+
+**Dialogs appear centered in the page**, with a visible backdrop that dims the rest of the window for focus.
+
+**All dialogs should have a title and a close button**. Use the `title` prop to set the title. The close button is created automatically, but must be handled with an `onClose` prop.
+
+**Dialogs are modal**. Dialogs can be dismissed by clicking on the close button, or by interacting with another button in the overlay. To avoid losing information and missing important messages, clicking outside of the dialog will not close it.
+
+**(Coming soon) Make sure larger dialogs remain mobile-friendly**. Even large dialogs need to be responsive. A dialog's width and height will be readjusted depending on the screen size and should never exceed the available space. Use responsive solutions to adjust the UI so they behave well on smaller screens.
+
+**(Coming soon) Simple and small dialogs can remain as-is on mobile**. As more elements are added to it, mobile-specific style variations such as **Bottom sheet** and **Full-screen** should be considered.
+
+### State
+
+The dialog component is completely stateless. The parent component must conditionally render a dialog based on the necessary criteria. The parent component can be notified by a gesture to close the dialog (e.g. by clicking the "X" button or by pressing the Escape key) by passing in the `onClose` prop.
+
+### Accessibility
+
+The dialog component is fully accessible out-of-the-box. The dialog's title is used for `aria-labelledby`, and the dialog's description is used for `aria-describedby`. The `aria-modal="true"` attribute is used to inform screen readers that the rest of the content on the page is inert.
+
+#### Keyboard
+
+The default keyboard API for a dialog employs three mechanisms:
+
+1. The Escape key can be pressed to close the dialog.
+2. Focus is trapped within the top-most dialog. When a dialog is opened, the close button receives initial focus by default, or on a button defined with `autoFocus: true`.
+3. If there are buttons in the dialog footer, focus can be moved between them with left and right arrow keys or tab/shift+tab.
+4. When a dialog is closed, it can optionally handle returning focus to the element that was focused immediately before the dialog was opened. Otherwise, it is the consumer's responsibility to move focus to a suitable element.
+
+### Custom rendering
+
+**Note: using custom rendering allows breaking out of the defined design, UX, and accessibility patterns of the dialog. Use only as a last resort.**
+
+By default, the Dialog component implements the design and interactions defined by the Primer design system. If necessary, you can provide custom renderers for the header, body, or footer using the `renderHeader`, `renderBody`, and `renderFooter` props, respectively. The JSX produced by these render props will render full-bleed into their respective areas of the dialog. If you are using the custom renderers, you should use the provided sub-components `Dialog.Header`, `Dialog.Title`, `Dialog.Subtitle`, `Dialog.CloseButton`, `Dialog.Body`, `Dialog.Footer`, and `Dialog.Buttons` to the extent possible.
+
+### Example
+
+```jsx live
+<State default={false}>
+  {([isOpen, setIsOpen]) => {
+    const openDialog = React.useCallback(() => setIsOpen(true), [setIsOpen])
+    const closeDialog = React.useCallback(() => setIsOpen(false), [setIsOpen])
+    return (
+      <>
+        <Button onClick={openDialog}>Open</Button>
+        {isOpen && (
+          <Dialog2
+            title="Dialog example"
+            subtitle={
+              <>
+                This is a <b>description</b> of the dialog.
+              </>
+            }
+            footerButtons={[{content: 'Ok', onClick: closeDialog}]}
+            onClose={closeDialog}
+          >
+            <Text fontFamily="sans-serif">Some content</Text>
+          </Dialog2>
+        )}
+      </>
+    )
+  }}
+</State>
+```
+
+## Component props
+
+### DialogProps
+
+| Prop name     | Type                                           | Default    | Description                                                                                                                                                                                                                                                             |
+| :------------ | :--------------------------------------------- | :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| title         | `React.ReactNode`                              | `"Dialog"` | Sets the title of the dialog, which by default is also used as the `aria-labelledby` attribute.                                                                                                                                                                         |
+| subtitle      | `React.ReactNode`                              |            | Optional. Sets the subtitle of the dialog, which by default is also used as the `aria-describedby` attribute.                                                                                                                                                           |
+| renderHeader  | `(props: DialogHeaderProps) => JSX.Element`    |            | Optional. Custom render the dialog header. See "Custom rendering" above for more info.                                                                                                                                                                                  |
+| renderBody    | `(props: DialogProps) => JSX.Element`          |            | Optional. Custom render the dialog body. See "Custom rendering" above for more info.                                                                                                                                                                                    |
+| renderFooter  | `(props: DialogProps) => JSX.Element`          |            | Optional. Custom render the dialog footer. See "Custom rendering" above for more info.                                                                                                                                                                                  |
+| footerButtons | `DialogButtonProps[]`                          |            | Optional. Specify buttons that will be rendered in the footer of the dialog.                                                                                                                                                                                            |
+| onClose       | `(gesture: 'close-button' │ 'escape') => void` |            | Required. This method is invoked when a gesture to close the dialog is used (either an Escape key press or clicking the "X" in the top-right corner). The gesture argument indicates the gesture that was used to close the dialog (either 'close-button' or 'escape'). |
+| role          | `"dialog" │ "alertdialog"`                     | `"dialog"` | The ARIA role given to the dialog element. More info: [dialog](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal), [alertdialog](https://www.w3.org/TR/wai-aria-practices-1.1/#alertdialog)                                                                    |
+| width         | `"small" │ "medium" │ "large" │ "xlarge"`      | `"xlarge"` | The fixed width of the dialog.                                                                                                                                                                                                                                          |
+| height        | `"small" │ "large" │ "auto"`                   | `"auto"`   | The fixed height of the dialog, or, auto to adjust the height based on its contents.                                                                                                                                                                                    |
+| sx            | `SystemStyleObject`                            | {}         | Style to be applied to the component                                                                                                                                                                                                                                    |
+
+### DialogHeaderProps
+
+The `DialogHeaderProps` interface extends `DialogProps` and adds these additional properties:
+
+| Prop name           | Type     | Description                                                                                                                                                     |
+| :------------------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| dialogLabelId       | `string` | ID of the element that will be used as the `aria-labelledby` attribute on the dialog. This ID should be set to the element that renders the dialog's title.     |
+| dialogDescriptionId | `string` | ID of the element that will be used as the `aria-describedby` attribute on the dialog. This ID should be set to the element that renders the dialog's subtitle. |
+
+### DialogButtonProps
+
+The `DialogButtonProps` interface extends `ButtonProps` (see Button) and adds these additional properties:
+
+| Prop name  | Type                              | Default  | Description                                                                                                                                                        |
+| :--------- | :-------------------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| buttonType | `"normal" │ "primary" │ "danger"` | `Button` | The type of button to render                                                                                                                                       |
+| content    | `React.ReactNode`                 |          | Required. The button's inner content.                                                                                                                              |
+| autoFocus  | `boolean`                         | false    | If true, this button will be automatically focused when the dialog is first rendered. If `autoFocus` is true on subsequent button definitions, it will be ignored. |
+
+## ConfirmationDialog
+
+A `ConfirmationDialog` is a special kind of dialog with more rigid behavior. It is used to confirm a user action. `ConfirmationDialog`s always have exactly two buttons: one to cancel the action and one to confirm it. No custom rendering capabilities are provided for ConfirmationDialog.
+
+### useConfirm hook
+
+An alternate way to use `ConfirmationDialog` is with the `useConfirm()` hook. It takes no parameters and returns an `async` function, `confirm`. When `confirm` is called (see ConfirmOptions below for its argument), it shows the confirmation dialog. When the dialog is dismissed, a promise is resolved with `true` or `false` depending on whether or not the confirm button was used.
+
+### Example (with `useConfirm` hook)
+
+```javascript live noinline
+function ShorthandExample2() {
+  const confirm = useConfirm()
+  const buttonClick = React.useCallback(
+    async function (e) {
+      if (await confirm({title: 'Are you sure?', content: 'You must confirm this action to continue.'})) {
+        e.target.textContent = 'Confirmed!'
+      }
+    },
+    [confirm]
+  )
+  return (
+    <>
+      <Button onClick={buttonClick}>Confirmable action</Button>
+    </>
+  )
+}
+render(<ShorthandExample2 />)
+```
+
+### Example (using the full `ConfirmationDialog` component)
+
+```jsx live
+<State default={false}>
+  {([isOpen, setIsOpen]) => {
+    const openDialog = React.useCallback(() => setIsOpen(true), [setIsOpen])
+    const closeDialog = React.useCallback(() => setIsOpen(false), [setIsOpen])
+    return (
+      <>
+        <Button onClick={openDialog}>Open</Button>
+        {isOpen && (
+          <ConfirmationDialog title="Confirm action?" onClose={closeDialog}>
+            Are you sure you want to confirm this action?
+          </ConfirmationDialog>
+        )}
+      </>
+    )
+  }}
+</State>
+```
+
+### ConfirmationDialogProps
+
+| Prop name            | Type                                                                  | Default    | Description                                                                                                                   |
+| :------------------- | :-------------------------------------------------------------------- | :--------- | :---------------------------------------------------------------------------------------------------------------------------- |
+| title                | `React.ReactNode`                                                     |            | Required. Sets the title of the dialog, which by default is also used as the `aria-labelledby` attribute.                     |
+| onClose              | `(gesture: 'confirm' │ 'cancel' │ 'close-button' │ 'escape') => void` |            | Required. This callback is invoked when a gesture to close the dialog is performed. The first argument indicates the gesture. |
+| cancelButtonContent  | `React.ReactNode`                                                     | `"Cancel"` | The content to use for the cancel button.                                                                                     |
+| confirmButtonContent | `React.ReactNode`                                                     | `"OK"`     | The content to use for the confirm button.                                                                                    |
+| confirmButtonType    | `"normal" │ "primary" │ "danger"`                                     | `Button`   | The type of button to use for the confirm button.                                                                             |
+
+### ConfirmOptions
+
+| Prop name            | Type                              | Default    | Description                                                                                               |
+| :------------------- | :-------------------------------- | :--------- | :-------------------------------------------------------------------------------------------------------- |
+| title                | `React.ReactNode`                 |            | Required. Sets the title of the dialog, which by default is also used as the `aria-labelledby` attribute. |
+| content              | `React.ReactNode`                 |            | Required. Used as the body of the ConfirmationDialog that is displayed.                                   |
+| cancelButtonContent  | `React.ReactNode`                 | `"Cancel"` | The content to use for the cancel button.                                                                 |
+| confirmButtonContent | `React.ReactNode`                 | `"OK"`     | The content to use for the confirm button.                                                                |
+| confirmButtonType    | `"normal" │ "primary" │ "danger"` | `Button`   | The type of button to use for the confirm button.                                                         |

package/docs/content/Dropdown.md

@@ -0,0 +1,65 @@
+---
+title: Dropdown
+---
+
+The Dropdown component is a lightweight context menu for housing navigation and actions.
+
+Use `Dropdown.Button` as the trigger for the dropdown, or use a custom `summary` element if you would like. **You must use a `summary` tag in order for the dropdown to behave properly!**. You should also add `aria-haspopup="true"` to custom dropdown triggers for accessibility purposes. You can use the `Dropdown.Caret` component to add a caret to a custom dropdown trigger.
+
+Dropdown.Menu wraps your menu content. Be sure to pass a `direction` prop to this component to position the menu in relation to the Dropdown.Button.
+
+## Default example
+
+```jsx live
+<Dropdown>
+  <Dropdown.Button>Dropdown</Dropdown.Button>
+  <Dropdown.Menu direction="sw">
+    <Dropdown.Item>Item 1</Dropdown.Item>
+    <Dropdown.Item>Item 2</Dropdown.Item>
+    <Dropdown.Item>Item 3</Dropdown.Item>
+  </Dropdown.Menu>
+</Dropdown>
+```
+
+## With custom button
+
+```jsx live
+<Dropdown>
+  <summary>
+    Dropdown
+    <Dropdown.Caret />
+  </summary>
+  <Dropdown.Menu direction="sw">
+    <Dropdown.Item>Item 1</Dropdown.Item>
+    <Dropdown.Item>Item 2</Dropdown.Item>
+    <Dropdown.Item>Item 3</Dropdown.Item>
+  </Dropdown.Menu>
+</Dropdown>
+```
+
+## Component props
+
+The Dropdown component is extended from the [`Details`](/Details) component and gets all props that the [`Details`](/Details) component gets.
+
+#### Dropdown.Menu
+
+| Name      | Type              | Default | Description                                                                           |
+| :-------- | :---------------- | :-----: | :------------------------------------------------------------------------------------ |
+| direction | String            |  'sw'   | Sets the direction of the dropdown menu. Pick from 'ne', 'e', 'se', 's', 'sw', or 'w' |
+| sx        | SystemStyleObject |   {}    | Style to be applied to the component                                                  |
+
+#### Dropdown.Button
+
+See https://primer.style/react/Buttons#component-props
+
+#### Dropdown.Caret
+
+| Name | Type              | Default | Description                          |
+| :--- | :---------------- | :-----: | :----------------------------------- |
+| sx   | SystemStyleObject |   {}    | Style to be applied to the component |
+
+#### Dropdown.Item
+
+| Name | Type              | Default | Description                          |
+| :--- | :---------------- | :-----: | :----------------------------------- |
+| sx   | SystemStyleObject |   {}    | Style to be applied to the component |

package/docs/content/DropdownMenu.mdx

@@ -0,0 +1,49 @@
+---
+title: DropdownMenu
+---
+
+A `DropdownMenu` provides an anchor (button by default) that will open a floating menu of selectable items. The menu can be opened and navigated using keyboard or mouse. When an item is selected, the menu will close and the `onChange` callback will be called. If the default anchor button is used, the anchor contents will be updated with the selection.
+
+## Example
+
+```javascript live noinline
+function DemoComponent() {
+  const items = React.useMemo(
+    () => [
+      {text: '🔵 Cyan', id: 5, key: 'cyan'},
+      {text: '🔴 Magenta', key: 'magenta'},
+      {text: '🟡 Yellow', key: 'yellow'}
+    ],
+    []
+  )
+  const [selectedItem, setSelectedItem] = React.useState()
+
+  return (
+    <DropdownMenu
+      renderAnchor={({children, 'aria-labelledby': ariaLabelledBy, ...anchorProps}) => (
+        <DropdownButton aria-labelledby={`favorite-color-label ${ariaLabelledBy}`} {...anchorProps}>
+          {children}
+        </DropdownButton>
+      )}
+      placeholder="🎨"
+      items={items}
+      selectedItem={selectedItem}
+      onChange={setSelectedItem}
+    />
+  )
+}
+
+render(<DemoComponent />)
+```
+
+## Component props
+
+| Name          | Type                                          |      Default      | Description                                                                                                                                                                                    |
+| :------------ | :-------------------------------------------- | :---------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| items         | `ItemProps[]`                                 |    `undefined`    | Required. A list of item objects to display in the menu                                                                                                                                        |
+| selectedItem  | `ItemInput`                                   |    `undefined`    | An `ItemProps` item from the list of `items` which is currently selected. This item will receive a checkmark next to it in the menu.                                                           |
+| onChange?     | (item?: ItemInput) => unknown                 |    `undefined`    | A callback which receives the selected item or `undefined` when an item is activated in the menu. If the activated item is the same as the current `selectedItem`, `undefined` will be passed. |
+| placeholder   | `string`                                      |    `undefined`    | Optional. A placeholder value to display when there is no current selection.                                                                                                                   |
+| renderAnchor  | `(props: DropdownButtonProps) => JSX.Element` | `DropdownButton`  | Optional. If defined, provided component will be used to render the menu anchor. Will receive the selected `Item` text as `children` prop when an item is activated.                           |
+| renderItem    | `(props: ItemProps) => JSX.Element`           | `ActionList.Item` | Optional. If defined, each item in `items` will be passed to this function, allowing for custom item rendering.                                                                                |
+| groupMetadata | `GroupProps[]`                                |    `undefined`    | Optional. If defined, `DropdownMenu` will group `items` into `ActionList.Group`s separated by `ActionList.Divider` according to their `groupId` property.                                      |

package/docs/content/FilterList.md

@@ -0,0 +1,37 @@
+---
+title: FilterList
+---
+
+The FilterList component is a menu with filter options that filter the main content of the page.
+
+## Default example
+
+```jsx live
+<FilterList>
+  <FilterList.Item selected count={32} href="#foo">
+    First Filter
+  </FilterList.Item>
+  <FilterList.Item count={2} href="#bar">
+    Second Filter
+  </FilterList.Item>
+  <FilterList.Item href="#baz">Third Filter</FilterList.Item>
+</FilterList>
+```
+
+## Component props
+
+#### FilterList
+
+| Name | Type              | Default | Description                          |
+| :--- | :---------------- | :-----: | :----------------------------------- |
+| sx   | SystemStyleObject |   {}    | Style to be applied to the component |
+
+#### FilterList.Item
+
+| Name     | Type              | Default | Description                                                      |
+| :------- | :---------------- | :-----: | :--------------------------------------------------------------- |
+| count    | Number            |         | Number to be displayed in the list item                          |
+| as       | String            |   `a`   | sets the HTML tag for the component                              |
+| selected | Boolean           |         | Used to set selected style                                       |
+| small    | Boolean           |  false  | Used to create a smaller version of the standard FilterList.Item |
+| sx       | SystemStyleObject |   {}    | Style to be applied to the component                             |

package/docs/content/FilteredSearch.md

@@ -0,0 +1,32 @@
+---
+title: FilteredSearch
+---
+
+The FilteredSearch component helps style a Dropdown and a TextInput side-by-side.
+
+**Note:** You _must_ use a `TextInput` and `Dropdown` (or native `<details>` and `<summary>`) in order for this component to work properly.
+
+## Default example
+
+```jsx live
+<FilteredSearch>
+  <Dropdown>
+    <Dropdown.Button>Filter</Dropdown.Button>
+    <Dropdown.Menu direction="sw">
+      <Dropdown.Item>Item 1</Dropdown.Item>
+      <Dropdown.Item>Item 2</Dropdown.Item>
+      <Dropdown.Item>Item 3</Dropdown.Item>
+    </Dropdown.Menu>
+  </Dropdown>
+  <TextInput icon={SearchIcon} />
+</FilteredSearch>
+```
+
+## Component props
+
+#### FilteredSearch.Children
+
+| Name     | Type              | Default | Description                                                                                              |
+| :------- | :---------------- | :-----: | :------------------------------------------------------------------------------------------------------- |
+| children |                   |         | FilteredSearch is expected to contain a [`Dropdown`](/Dropdown) followed by a [`TextInput`](/TextInput). |
+| sx       | SystemStyleObject |   {}    | Style to be applied to the component                                                                     |

package/docs/content/Flash.md

@@ -0,0 +1,35 @@
+---
+title: Flash
+---
+
+The Flash component informs users of successful or pending actions.
+
+## Default example
+
+```jsx live
+<>
+  <Flash>Default Flash</Flash>
+  <Flash variant="success">Success Flash</Flash>
+  <Flash variant="warning">Warning Flash</Flash>
+  <Flash variant="danger">Danger Flash</Flash>
+</>
+```
+
+## With an icon
+
+Flash components with icons inside of them will automatically set the correct color for the icon depending on the type of Flash, as well as applying the correct right margin.
+
+```jsx live
+<Flash variant="success">
+  <StyledOcticon icon={CheckIcon} />
+  Success!
+</Flash>
+```
+
+## Component props
+
+| Name    | Type              | Default | Description                                                                                                              |
+| :------ | :---------------- | :-----: | :----------------------------------------------------------------------------------------------------------------------- |
+| full    | Boolean           |         | Creates a full width Flash component                                                                                     |
+| sx      | SystemStyleObject |   {}    | Style to be applied to the component                                                                                     |
+| variant | String            | default | Can be one of `default`, `success`, `warning`, or `danger` - sets the background color and border of the Flash component |

package/docs/content/Flex.md

@@ -0,0 +1,58 @@
+---
+title: Flex
+status: Deprecated
+---
+
+The `Flex` component behaves the same as the `Box` component except that it has `display: flex` set by default.
+
+## Deprecation
+
+Use [Box](/Box) instead.
+
+**Before**
+
+```jsx
+<Flex flexWrap="nowrap">
+  <Box p={3} color="fg.onEmphasis" bg="accent.emphasis">
+    Item 1
+  </Box>
+</Flex>
+```
+
+**After**
+
+```jsx
+<Box display="flex" flexWrap="nowrap">
+  <Box p={3} color="fg.onEmphasis" bg="accent.emphasis">
+    Item 1
+  </Box>
+</Box>
+```
+
+## Default example
+
+```jsx live
+<Box borderWidth="1px" borderStyle="solid" borderColor="border.default" width={300} height={300} borderRadius={0}>
+  <Flex flexWrap="nowrap">
+    <Box p={3} color="fg.onEmphasis" bg="accent.emphasis">
+      Item 1
+    </Box>
+    <Box p={3} color="fg.onEmphasis" bg="attention.emphasis">
+      Item 2
+    </Box>
+    <Box p={3} color="fg.onEmphasis" bg="danger.emphasis">
+      Item 3
+    </Box>
+  </Flex>
+</Box>
+```
+
+## System props
+
+Flex components get `FLEX`, `COMMON`, and `LAYOUT` system props.
+
+Read our [System Props](/system-props) doc page for a full list of available props.
+
+## Component props
+
+`Flex` does not get any additional props other than the system props mentioned above.

package/docs/content/FormGroup.md

@@ -0,0 +1,38 @@
+---
+title: FormGroup
+---
+
+Adds styles for multiple form elements used together.
+
+## Default example
+
+```jsx live
+<>
+  <FormGroup>
+    <FormGroup.Label htmlFor="example-text">Example text</FormGroup.Label>
+    <TextInput id="example-text" value="Example Value" />
+  </FormGroup>
+
+  <FormGroup>
+    <FormGroup.Label htmlFor="example-text-b">Example text</FormGroup.Label>
+    <TextInput id="example-text-b" value="Example Value" />
+  </FormGroup>
+</>
+```
+
+## Component props
+
+### FormGroup
+
+| Name | Type              | Default | Description                          |
+| :--- | :---------------- | :-----: | :----------------------------------- |
+| as   | String            |  `div`  | Sets the HTML tag for the component  |
+| sx   | SystemStyleObject |   {}    | Style to be applied to the component |
+
+### FormGroup.Label
+
+| Name    | Type              | Default | Description                                                                    |
+| :------ | :---------------- | :-----: | :----------------------------------------------------------------------------- |
+| as      | String            | `label` | Sets the HTML tag for the component                                            |
+| htmlFor | String            |         | The value of `htmlFor` needs to be the same as the `id` of the input it labels |
+| sx      | SystemStyleObject |   {}    | Style to be applied to the component                                           |

package/docs/content/Grid.md

@@ -0,0 +1,59 @@
+---
+title: Grid
+status: Deprecated
+---
+
+Grid is a component that exposes grid system props. See the [CSS Tricks Complete Guide to Grid](https://css-tricks.com/snippets/css/complete-guide-grid/) to learn more about Grid Layout.
+
+## Deprecation
+
+Use [Box](/Box) instead.
+
+**Before**
+
+```jsx
+<Grid gridTemplateColumns="repeat(2, auto)" gridGap={3}>
+  <Box p={3} color="fg.onEmphasis" bg="accent.emphasis">
+    1
+  </Box>
+  <Box p={3} color="fg.onEmphasis" bg="attention.emphasis">
+    2
+  </Box>
+</Grid>
+```
+
+**After**
+
+```jsx
+<Box display="grid" gridTemplateColumns="repeat(2, auto)" gridGap={3}>
+  <Box p={3} color="fg.onEmphasis" bg="accent.emphasis">
+    1
+  </Box>
+  <Box p={3} color="fg.onEmphasis" bg="attention.emphasis">
+    2
+  </Box>
+</Box>
+```
+
+## Default example
+
+```jsx live
+<Grid gridTemplateColumns="repeat(2, auto)" gridGap={3}>
+  <Box p={3} color="fg.onEmphasis" bg="accent.emphasis">
+    1
+  </Box>
+  <Box p={3} color="fg.onEmphasis" bg="attention.emphasis">
+    2
+  </Box>
+</Grid>
+```
+
+## System props
+
+Grid components get `GRID`, `COMMON`, and `LAYOUT` system props.
+
+Read our [System Props](/system-props) doc page for a full list of available props.
+
+## Component props
+
+`Grid` does not get any additional props other than the system props mentioned above.

package/docs/content/Header.md

@@ -0,0 +1,77 @@
+---
+title: Header
+---
+
+Use the `Header` component to create a header that has all of its items aligned vertically with consistent horizontal spacing.
+
+## Default example
+
+All items directly under the Header component should be a `Header.Item` component. Inside these components can be anything (text, forms, images...), and the `Header.Item` component will make sure these elements vertically align with each other.
+
+`Header.Item` elements have a built-in margin that will need to be overridden with the `mr={0}` props for the last element in the container. We relied on the prop here instead of `:last-child` because the last child isn't always the item visible. On responsive pages, there's a mobile menu that gets presented to the user at smaller breakpoints.
+
+```jsx live
+<Header>
+  <Header.Item>
+    <Header.Link href="#" fontSize={2}>
+      <StyledOcticon icon={MarkGithubIcon} size={32} mr={2} />
+      <span>GitHub</span>
+    </Header.Link>
+  </Header.Item>
+  <Header.Item full>Menu</Header.Item>
+  <Header.Item mr={0}>
+    <Avatar src="https://github.com/octocat.png" size={20} square alt="@octocat" />
+  </Header.Item>
+</Header>
+```
+
+## Header with full-size item example
+
+```jsx live
+<Header>
+  <Header.Item>Item 1</Header.Item>
+  <Header.Item full border={1} borderStyle="solid">
+    Item 2
+  </Header.Item>
+  <Header.Item mr={0}>Item 3</Header.Item>
+</Header>
+```
+
+## Header with links example
+
+```jsx live
+<Header>
+  <Header.Item>
+    <Header.Link href="#">About</Header.Link>
+  </Header.Item>
+  <Header.Item>
+    <Header.Link href="#">Releases</Header.Link>
+  </Header.Item>
+  <Header.Item>
+    <Header.Link href="#">Team</Header.Link>
+  </Header.Item>
+</Header>
+```
+
+## Component props
+
+### Header
+
+| Name | Type              | Default | Description                          |
+| :--- | :---------------- | :-----: | :----------------------------------- |
+| sx   | SystemStyleObject |   {}    | Style to be applied to the component |
+
+### Header.Item
+
+| Name | Type              | Default | Description                                |
+| :--- | :---------------- | :-----: | :----------------------------------------- |
+| full | Boolean           |         | stretches item to fill the available space |
+| sx   | SystemStyleObject |   {}    | Style to be applied to the component       |
+
+### Header.Link
+
+| Name | Type              | Default | Description                          |
+| :--- | :---------------- | :-----: | :----------------------------------- |
+| as   | String            |         | sets the HTML tag for the component  |
+| href | String            |         | URL to be used for the Link          |
+| sx   | SystemStyleObject |   {}    | Style to be applied to the component |