Skip to content

Updates SegmentedControl to Alpha status #2228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 18, 2022
Merged

Updates SegmentedControl to Alpha status #2228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fee0675
updates SegmentedControl to Alpha status
mperrotti Aug 12, 2022
4f59c18
Merge branch 'main' of github.com:primer/react into mp/segmented-conr…
mperrotti Aug 12, 2022
b068755
adds changeset
mperrotti Aug 12, 2022
699578d
keeps SegmentedControl in drafts bundle to avoid a breaking change
mperrotti Aug 12, 2022
860f34e
moves SegmentedControl above Select in docs sidebar
mperrotti Aug 15, 2022
285cdff
Merge branch 'main' into mp/segmented-conrol-draft-to-alpha
siddharthkp Aug 16, 2022
0cb0c10
Merge branch 'main' into mp/segmented-conrol-draft-to-alpha
mperrotti Aug 17, 2022
4cfa554
Update docs/content/SegmentedControl.mdx
mperrotti Aug 17, 2022
b26af80
Merge branch 'main' into mp/segmented-conrol-draft-to-alpha
mperrotti Aug 17, 2022
c33301f
Merge branch 'main' into mp/segmented-conrol-draft-to-alpha
mperrotti Aug 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/unlucky-ways-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': minor
---

Moves SegmentedControl to the main bundle and updates it's lifecycle status to "Alpha"
39 changes: 20 additions & 19 deletions docs/content/drafts/SegmentedControl.mdx → docs/content/SegmentedControl.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
componentId: segmented_control
title: SegmentedControl
status: Draft
description: Use a segmented control to let users select an option from a short list and immediately apply the selection
status: Alpha
Copy link
Contributor Author

@mperrotti mperrotti Aug 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The component lifecycle label doesn't appear to be updating. Is there something else I need to do to get this showing "Alpha" instead of "Drafts"?

Screen Shot 2022-08-15 at 11 56 22 AM

Copy link
Member

@siddharthkp siddharthkp Aug 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be related to preview deployment build because I see your changes on my machine 🤔

Copy link
Member

@siddharthkp siddharthkp Aug 16, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deployment is fixed now, turns out it was my fault ✨ 🙃

---

## Examples

### Uncontrolled (default)

```jsx live drafts
```jsx live
<SegmentedControl aria-label="File view">
<SegmentedControl.Button defaultSelected>Preview</SegmentedControl.Button>
<SegmentedControl.Button>Raw</SegmentedControl.Button>
Expand All @@ -18,7 +19,7 @@ description: Use a segmented control to let users select an option from a short

### Controlled

```javascript noinline live drafts
```javascript noinline live
const Controlled = () => {
const [selectedIndex, setSelectedIndex] = React.useState(0)

Expand All @@ -40,7 +41,7 @@ render(Controlled)

### With icons and labels

```jsx live drafts
```jsx live
<SegmentedControl aria-label="File view">
<SegmentedControl.Button defaultSelected leadingIcon={EyeIcon}>
Preview
Expand All @@ -52,7 +53,7 @@ render(Controlled)

### With icons only

```jsx live drafts
```jsx live
<SegmentedControl aria-label="File view">
<SegmentedControl.IconButton defaultSelected icon={EyeIcon} aria-label="Preview" />
<SegmentedControl.IconButton icon={FileCodeIcon} aria-label="Raw" />
Expand All @@ -62,7 +63,7 @@ render(Controlled)

### With labels hidden on smaller viewports

```jsx live drafts
```jsx live
<SegmentedControl aria-label="File view" variant={{narrow: 'hideLabels', regular: 'default'}}>
<SegmentedControl.Button defaultSelected leadingIcon={EyeIcon}>
Preview
Expand All @@ -74,7 +75,7 @@ render(Controlled)

### Convert to a dropdown on smaller viewports

```jsx live drafts
```jsx live
<SegmentedControl aria-label="File view" variant={{narrow: 'dropdown', regular: 'default'}}>
<SegmentedControl.Button defaultSelected leadingIcon={EyeIcon}>
Preview
Expand All @@ -86,7 +87,7 @@ render(Controlled)

### Fill width of parent

```jsx live drafts
```jsx live
<SegmentedControl fullWidth aria-label="File view">
<SegmentedControl.Button defaultSelected>Preview</SegmentedControl.Button>
<SegmentedControl.Button>Raw</SegmentedControl.Button>
Expand All @@ -96,7 +97,7 @@ render(Controlled)

### With a label and caption on the left

```jsx live drafts
```jsx live
<Box display="flex">
<Box flexGrow={1}>
<Text fontSize={2} fontWeight="bold" id="scLabel-vert" display="block">
Expand All @@ -116,7 +117,7 @@ render(Controlled)

### With a label above and caption below

```jsx live drafts
```jsx live
<FormControl>
<FormControl.Label id="scLabel-horiz">File view</FormControl.Label>
<SegmentedControl aria-labelledby="scLabel-horiz" aria-describedby="scCaption-horiz">
Expand All @@ -130,7 +131,7 @@ render(Controlled)

### With something besides the first option selected

```jsx live drafts
```jsx live
<SegmentedControl aria-label="File view">
<SegmentedControl.Button>Preview</SegmentedControl.Button>
<SegmentedControl.Button defaultSelected>Raw</SegmentedControl.Button>
Expand Down Expand Up @@ -223,15 +224,15 @@ render(Controlled)
<ComponentChecklist
items={{
propsDocumented: true,
noUnnecessaryDeps: false,
adaptsToThemes: false,
adaptsToScreenSizes: false,
fullTestCoverage: false,
noUnnecessaryDeps: true,
adaptsToThemes: true,
adaptsToScreenSizes: true,
fullTestCoverage: true,
usedInProduction: false,
usageExamplesDocumented: false,
hasStorybookStories: false,
designReviewed: false,
a11yReviewed: false,
usageExamplesDocumented: true,
hasStorybookStories: true,
designReviewed: true,
a11yReviewed: true,
stableApi: false,
addressedApiFeedback: false,
hasDesignGuidelines: false,
Expand Down
2 changes: 2 additions & 0 deletions docs/src/@primer/gatsby-theme-doctocat/nav.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@
url: /Radio
- title: RadioGroup
url: /RadioGroup
- title: SegmentedControl
url: /SegmentedControl
- title: Select
url: /Select
- title: SelectPanel
Expand Down
2 changes: 1 addition & 1 deletion src/drafts/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
export * from '../NavList'
export * from '../Dialog/Dialog'
export * from '../SegmentedControl'
export * from '../SegmentedControl' // TODO: remove from drafts bundle in next major release
export * from '../SplitPageLayout'

export {default as InlineAutocomplete} from './InlineAutocomplete'
Expand Down
1 change: 1 addition & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ export type {PortalProps} from './Portal'
export {default as ProgressBar} from './ProgressBar'
export type {ProgressBarProps} from './ProgressBar'
export {default as RadioGroup} from './RadioGroup'
export {SegmentedControl} from './SegmentedControl'
export {default as Select} from './Select'
export type {SelectProps} from './Select'
export {SelectPanel} from './SelectPanel'
Expand Down