Skip to content

Commit 13651ba

Browse files
authored
Promote TreeView to beta 🎉 (#2903)
* Promote TreeView to beta * Move TreeView link in nay.yml * Update checklist wording for consistency * Add source and storybook links to TreeView docs * Update generated/components.json * Create .changeset/forty-squids-pretend.md * update snapshots --------- Co-authored-by: colebemis <colebemis@users.noreply.github.com>
1 parent 9edd911 commit 13651ba

File tree

9 files changed

+48
-26
lines changed

9 files changed

+48
-26
lines changed

.changeset/forty-squids-pretend.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
"@primer/react": minor
3+
---
4+
5+
TreeView promoted to [beta](https://primer.style/contribute/component-lifecycle#beta) status. You can now import it from the main bundle instead of `/drafts`:
6+
7+
```diff
8+
- import {TreeView} from '@primer/react/drafts'
9+
+ import {TreeView} from '@primer/react'
10+
```

docs/content/TreeView.mdx

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
22
title: TreeView
33
componentId: tree_view
4-
status: Draft
4+
status: Beta
55
description: A hierarchical list of items where nested items can be expanded and collapsed.
6+
a11yReviewed: true
7+
source: https://github.com/primer/react/tree/main/src/TreeView
8+
storybook: '/react/storybook?path=/story/components-treeview'
69
---
710

811
import data from '../../src/TreeView/TreeView.docs.json'
912

1013
```js
11-
import {TreeView} from '@primer/react/drafts'
14+
import {TreeView} from '@primer/react'
1215
```
1316

1417
## Examples
@@ -280,15 +283,18 @@ See [Storybook](https://primer.style/react/storybook?path=/story/components-tree
280283
<ComponentChecklist
281284
items={{
282285
propsDocumented: true,
283-
noUnnecessaryDeps: false,
284-
adaptsToThemes: false,
285-
adaptsToScreenSizes: false,
286-
fullTestCoverage: false,
287-
usedInProduction: false,
288-
usageExamplesDocumented: false,
289-
hasStorybookStories: false,
290-
designReviewed: false,
291-
a11yReviewed: false,
286+
noUnnecessaryDeps: true,
287+
adaptsToThemes: true,
288+
adaptsToScreenSizes: true,
289+
fullTestCoverage: true,
290+
visualRegressionCoverage: true,
291+
noAxeViolations: true,
292+
usedInProduction: true,
293+
usageExamplesDocumented: true,
294+
hasStorybookStories: true,
295+
designReviewed: true,
296+
a11yReviewed: true,
297+
noPerfRegression: true,
292298
stableApi: false,
293299
addressedApiFeedback: false,
294300
hasDesignGuidelines: false,

docs/src/@primer/gatsby-theme-doctocat/nav.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@
150150
url: /Token
151151
- title: Tooltip
152152
url: /Tooltip
153+
- title: TreeView
154+
url: /TreeView
153155
- title: Truncate
154156
url: /Truncate
155157
- title: UnderlineNav
@@ -164,8 +166,6 @@
164166
url: /drafts/MarkdownEditor
165167
- title: MarkdownViewer
166168
url: /drafts/MarkdownViewer
167-
- title: TreeView
168-
url: /TreeView
169169
- title: UnderlineNav v2
170170
url: /drafts/UnderlineNav2
171171
- title: PageHeader

docs/src/component-checklist.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ export function ComponentChecklist({items}) {
2424
Component has robust unit test coverage (100% where achievable).
2525
</Checklist.Item>
2626
<Checklist.Item checked={items.visualRegressionCoverage}>
27-
The component has visual regression coverage of its default and interactive states.
27+
Component has visual regression coverage of its default and interactive states.
2828
</Checklist.Item>
2929
<Checklist.Item checked={items.noAxeViolations}>
30-
The component does not introduce any axe violations.
30+
Component does not introduce any axe violations.
3131
</Checklist.Item>
3232
<Checklist.Item checked={items.a11yReviewed}>
3333
Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

generated/components.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4287,8 +4287,8 @@
42874287
"tree_view": {
42884288
"id": "tree_view",
42894289
"name": "TreeView",
4290-
"status": "draft",
4291-
"a11yReviewed": false,
4290+
"status": "beta",
4291+
"a11yReviewed": true,
42924292
"stories": [
42934293
"components-treeview-features--files",
42944294
"components-treeview-features--files-changed"

src/TreeView/TreeView.docs.json

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
{
22
"id": "tree_view",
33
"name": "TreeView",
4-
"status": "draft",
5-
"a11yReviewed": false,
6-
"stories": [
7-
"components-treeview-features--files",
8-
"components-treeview-features--files-changed"
9-
],
4+
"status": "beta",
5+
"a11yReviewed": true,
6+
"stories": ["components-treeview-features--files", "components-treeview-features--files-changed"],
107
"props": [
118
{
129
"name": "children",
@@ -146,4 +143,4 @@
146143
]
147144
}
148145
]
149-
}
146+
}

src/__tests__/__snapshots__/exports.test.ts.snap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ exports[`@primer/react should not update exports without a semver change 1`] = `
7070
"ToggleSwitch",
7171
"Token",
7272
"Tooltip",
73+
"TreeView",
7374
"Truncate",
7475
"UnderlineNav",
7576
"UnderlineNav2",

src/drafts/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,8 @@ export {default as Hidden} from '../Hidden'
3030

3131
export * from './hooks'
3232

33-
export * from '../TreeView'
34-
3533
// TODO: Remove these components from the drafts bundle in the next major release
34+
export * from '../TreeView'
3635
export * from '../NavList'
3736
export * from '../SegmentedControl'
3837
export * from '../SplitPageLayout'

src/index.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,15 @@ export type {CheckboxProps} from './Checkbox'
179179
export {default as Textarea} from './Textarea'
180180
export type {TextareaProps} from './Textarea'
181181

182+
export {TreeView} from './TreeView'
183+
export type {
184+
TreeViewProps,
185+
TreeViewItemProps,
186+
TreeViewSubTreeProps,
187+
TreeViewVisualProps,
188+
TreeViewErrorDialogProps,
189+
} from './TreeView'
190+
182191
export {UnderlineNav as UnderlineNav2} from './UnderlineNav2'
183192

184193
export {SSRProvider, useSSRSafeId} from './utils/ssr'

0 commit comments

Comments
 (0)