Skip to content

Commit

Permalink
Rename unreleased to drafts to avoid confusion (#1609)
Browse files Browse the repository at this point in the history
* rename unreleased to drafts

* Create young-ties-fix.md
  • Loading branch information
siddharthkp authored Nov 16, 2021
1 parent 861abe7 commit 5eb7ade
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 11 deletions.
5 changes: 5 additions & 0 deletions .changeset/young-ties-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/components": patch
---

Rename `@primer/components/unreleased` to `@primer/components/drafts` to avoid confusion when referring to it.
22 changes: 14 additions & 8 deletions docs/content/ActionList2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: An ActionList is a list of items which can be activated or selected
---

import {BorderBox, Avatar} from '@primer/components'
import {ActionList} from '@primer/components/unreleased'
import {ActionList} from '@primer/components/drafts'
import {Props} from '../src/props'

import {ImageContainer} from '@primer/gatsby-theme-doctocat'
Expand Down Expand Up @@ -48,7 +48,7 @@ import {LinkIcon, AlertIcon, ArrowRightIcon} from '@primer/octicons-react'
<br />

```js
import {ActionList} from '@primer/components/unreleased'
import {ActionList} from '@primer/components/drafts'
```

<br />
Expand All @@ -58,7 +58,8 @@ import {ActionList} from '@primer/components/unreleased'
## Minimal example

```javascript live noinline
const {ActionList} = unreleased
// import {ActionList} from '@primer/components/drafts'
const {ActionList} = drafts // ignore docs silliness; import like that ↑

render(
<ActionList>
Expand All @@ -79,7 +80,8 @@ Leading visuals are optional and appear at the start of an item. They can be oct

<!-- prettier-ignore -->
```javascript live noinline
const {ActionList} = unreleased
// import {ActionList} from '@primer/components/drafts'
const {ActionList} = drafts // ignore docs silliness; import like that

render(
<ActionList>
Expand All @@ -106,7 +108,8 @@ render(
Trailing visual and trailing text can display auxiliary information. They're placed at the right of the item, and can denote status, keyboard shortcuts, or be used to set expectations about what the action does.
```javascript live noinline
const {ActionList} = unreleased
// import {ActionList} from '@primer/components/drafts'
const {ActionList} = drafts // ignore docs silliness; import like that ↑
render(
<ActionList>
Expand Down Expand Up @@ -137,7 +140,8 @@ render(
Item dividers allow users to parse heavier amounts of information. They're placed between items and are useful in complex lists, particularly when descriptions or multi-line text is present.

```javascript live noinline
const {ActionList} = unreleased
// import {ActionList} from '@primer/components/drafts'
const {ActionList} = drafts // ignore docs silliness; import like that ↑

render(
<ActionList showDividers>
Expand Down Expand Up @@ -172,7 +176,8 @@ When you want to add links to the List instead of actions, use `ActionList.LinkI

<!-- prettier-ignore -->
```javascript live noinline
const {ActionList} = unreleased
// import {ActionList} from '@primer/components/drafts'
const {ActionList} = drafts // ignore docs silliness; import like that

render(
<ActionList>
Expand Down Expand Up @@ -207,7 +212,8 @@ render(
## With Groups
```javascript live noinline
const {ActionList} = unreleased
// import {ActionList} from '@primer/components/drafts'
const {ActionList} = drafts // ignore docs silliness; import like that ↑
const SelectFields = () => {
const [options, setOptions] = React.useState([
Expand Down
4 changes: 2 additions & 2 deletions docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import React from 'react'
import * as primerComponents from '@primer/components'
import * as unreleased from '@primer/components/unreleased'
import * as drafts from '@primer/components/drafts'
import * as doctocatComponents from '@primer/gatsby-theme-doctocat'
import {
CheckIcon,
Expand Down Expand Up @@ -40,7 +40,7 @@ const ReactRouterLink = ({to, ...props}) => {
export default {
...doctocatComponents,
...primerComponents,
unreleased,
drafts,
ReactRouterLink,
State,
CheckIcon,
Expand Down
2 changes: 1 addition & 1 deletion src/unreleased.ts → src/drafts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* api yet (not in main bundle). We don't recommend using it in production.
*
* But, they are published on npm and you can import them for experimentation/feedback.
* example: import {ActionList} from '@primer/components/unreleased
* example: import {ActionList} from '@primer/components/drafts
*/

// Components
Expand Down

0 comments on commit 5eb7ade

Please sign in to comment.