Skip to content

Commit 5eb7ade

Browse files
authored
Rename unreleased to drafts to avoid confusion (#1609)
* rename unreleased to drafts * Create young-ties-fix.md
1 parent 861abe7 commit 5eb7ade

File tree

4 files changed

+22
-11
lines changed

4 files changed

+22
-11
lines changed

.changeset/young-ties-fix.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@primer/components": patch
3+
---
4+
5+
Rename `@primer/components/unreleased` to `@primer/components/drafts` to avoid confusion when referring to it.

docs/content/ActionList2.mdx

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: An ActionList is a list of items which can be activated or selected
77
---
88

99
import {BorderBox, Avatar} from '@primer/components'
10-
import {ActionList} from '@primer/components/unreleased'
10+
import {ActionList} from '@primer/components/drafts'
1111
import {Props} from '../src/props'
1212

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

5050
```js
51-
import {ActionList} from '@primer/components/unreleased'
51+
import {ActionList} from '@primer/components/drafts'
5252
```
5353

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

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

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

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

8486
render(
8587
<ActionList>
@@ -106,7 +108,8 @@ render(
106108
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.
107109
108110
```javascript live noinline
109-
const {ActionList} = unreleased
111+
// import {ActionList} from '@primer/components/drafts'
112+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
110113
111114
render(
112115
<ActionList>
@@ -137,7 +140,8 @@ render(
137140
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.
138141

139142
```javascript live noinline
140-
const {ActionList} = unreleased
143+
// import {ActionList} from '@primer/components/drafts'
144+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
141145

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

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

177182
render(
178183
<ActionList>
@@ -207,7 +212,8 @@ render(
207212
## With Groups
208213
209214
```javascript live noinline
210-
const {ActionList} = unreleased
215+
// import {ActionList} from '@primer/components/drafts'
216+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
211217
212218
const SelectFields = () => {
213219
const [options, setOptions] = React.useState([

docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react'
22
import * as primerComponents from '@primer/components'
3-
import * as unreleased from '@primer/components/unreleased'
3+
import * as drafts from '@primer/components/drafts'
44
import * as doctocatComponents from '@primer/gatsby-theme-doctocat'
55
import {
66
CheckIcon,
@@ -40,7 +40,7 @@ const ReactRouterLink = ({to, ...props}) => {
4040
export default {
4141
...doctocatComponents,
4242
...primerComponents,
43-
unreleased,
43+
drafts,
4444
ReactRouterLink,
4545
State,
4646
CheckIcon,

src/unreleased.ts renamed to src/drafts.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* api yet (not in main bundle). We don't recommend using it in production.
33
*
44
* But, they are published on npm and you can import them for experimentation/feedback.
5-
* example: import {ActionList} from '@primer/components/unreleased
5+
* example: import {ActionList} from '@primer/components/drafts
66
*/
77

88
// Components

0 commit comments

Comments
 (0)