Skip to content
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

Jump to bottom

Remove 'warning' status from form validation #3414

Merged
merged 8 commits into from
Jun 20, 2023
Merged

Remove 'warning' status from form validation #3414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
58b118f
3230 Refactor internal components - TextInputInnerVisualSlot (#3373)
green6erry Jun 8, 2023
6316996
removes 'warning' status from form validation
mperrotti Jun 15, 2023
fa9870a
Update generated/components.json
mperrotti Jun 15, 2023
f5e4617
adds changeset
mperrotti Jun 15, 2023
852a2d0
Merge branch 'mp/rm-warning-status' of github.com:primer/react into m…
mperrotti Jun 15, 2023
64acb74
Update old-coats-sniff.md
mperrotti Jun 19, 2023
e2518be
Merge branch 'next-major' into mp/rm-warning-status
mperrotti Jun 19, 2023
3de26ce
Merge branch 'next-major' into mp/rm-warning-status
mperrotti Jun 19, 2023
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/old-coats-sniff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': major
---

Removes 'warning' option from form components' `validationStatus` props
26 changes: 8 additions & 18 deletions docs/content/TextInput.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,26 +152,16 @@ render(<WithIconAndLoadingIndicator />)
</FormControl>
```

### With error and warning states
### With error state

```jsx live
<>
<TextInput
validationStatus="error"
aria-label="Zipcode"
name="zipcode"
placeholder="Error"
autoComplete="postal-code"
/>

<TextInput
validationStatus="warning"
aria-label="Zipcode"
name="zipcode"
placeholder="Warning"
autoComplete="postal-code"
/>
</>
<TextInput
validationStatus="error"
aria-label="Zipcode"
name="zipcode"
placeholder="Error"
autoComplete="postal-code"
/>
```

### Block text input
Expand Down
34 changes: 0 additions & 34 deletions e2e/components/CheckboxGroup.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,38 +174,4 @@ test.describe('CheckboxGroup', () => {
})
}
})

test.describe('Warning', () => {
for (const theme of themes) {
test.describe(theme, () => {
test('default @vrt', async ({page}) => {
await visit(page, {
id: 'components-checkboxgroup-features--warning',
globals: {
colorScheme: theme,
},
})

// Default state
expect(await page.screenshot({animations: 'disabled'})).toMatchSnapshot(`CheckboxGroup.Warning.${theme}.png`)
})

test('axe @aat', async ({page}) => {
await visit(page, {
id: 'components-checkboxgroup-features--warning',
globals: {
colorScheme: theme,
},
})
await expect(page).toHaveNoViolations({
rules: {
'color-contrast': {
enabled: false,
},
},
})
})
})
}
})
})
28 changes: 0 additions & 28 deletions e2e/components/RadioGroup.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,34 +143,6 @@ test.describe('RadioGroup', () => {
}
})

test.describe('Warning', () => {
for (const theme of themes) {
test.describe(theme, () => {
test('default @vrt', async ({page}) => {
await visit(page, {
id: 'components-radiogroup-features--warning',
globals: {
colorScheme: theme,
},
})

// Default state
expect(await page.screenshot({animations: 'disabled'})).toMatchSnapshot(`RadioGroup.Warning.${theme}.png`)
})

test('axe @aat', async ({page}) => {
await visit(page, {
id: 'components-radiogroup-features--warning',
globals: {
colorScheme: theme,
},
})
await expect(page).toHaveNoViolations()
})
})
}
})

test.describe('With External Label', () => {
for (const theme of themes) {
test.describe(theme, () => {
Expand Down
35 changes: 0 additions & 35 deletions e2e/components/Select.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,41 +279,6 @@ test.describe('Select', () => {
}
})

test.describe('Warning', () => {
for (const theme of themes) {
test.describe(theme, () => {
test('default @vrt', async ({page}) => {
await visit(page, {
id: 'components-select-features--warning',
globals: {
colorScheme: theme,
},
})

// Default state
expect(await page.screenshot({animations: 'disabled'})).toMatchSnapshot(`Select.Warning.${theme}.png`)
})

test('axe @aat', async ({page}) => {
await visit(page, {
id: 'components-select-features--warning',
globals: {
colorScheme: theme,
},
})
await expect(page.getByText('Warning')).toBeVisible()
await expect(page).toHaveNoViolations({
rules: {
'color-contrast': {
enabled: theme !== 'dark_dimmed',
},
},
})
})
})
}
})

test.describe('With Caption', () => {
for (const theme of themes) {
test.describe(theme, () => {
Expand Down
28 changes: 0 additions & 28 deletions e2e/components/TextInput.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,34 +227,6 @@ test.describe('TextInput', () => {
}
})

test.describe('Warning', () => {
for (const theme of themes) {
test.describe(theme, () => {
test('default @vrt', async ({page}) => {
await visit(page, {
id: 'components-textinput-features--warning',
globals: {
colorScheme: theme,
},
})

// Default state
expect(await page.screenshot({animations: 'disabled'})).toMatchSnapshot(`TextInput.Warning.${theme}.png`)
})

test('axe @aat', async ({page}) => {
await visit(page, {
id: 'components-textinput-features--warning',
globals: {
colorScheme: theme,
},
})
await expect(page).toHaveNoViolations()
})
})
}
})

test.describe('With Caption', () => {
for (const theme of themes) {
test.describe(theme, () => {
Expand Down
28 changes: 0 additions & 28 deletions e2e/components/Textarea.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,34 +171,6 @@ test.describe('Textarea', () => {
}
})

test.describe('Warning', () => {
for (const theme of themes) {
test.describe(theme, () => {
test('default @vrt', async ({page}) => {
await visit(page, {
id: 'components-textarea-features--warning',
globals: {
colorScheme: theme,
},
})

// Default state
expect(await page.screenshot({animations: 'disabled'})).toMatchSnapshot(`Textarea.Warning.${theme}.png`)
})

test('axe @aat', async ({page}) => {
await visit(page, {
id: 'components-textarea-features--warning',
globals: {
colorScheme: theme,
},
})
await expect(page).toHaveNoViolations()
})
})
}
})

test.describe('With Caption', () => {
for (const theme of themes) {
test.describe(theme, () => {
Expand Down
14 changes: 7 additions & 7 deletions generated/components.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1041,7 +1041,7 @@
},
{
"name": "validationStatus",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"description": "Only used to inform ARIA attributes.<br /> Individual checkboxes do not have validation styles."
},
Expand Down Expand Up @@ -1163,7 +1163,7 @@
},
{
"name": "variant",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"required": true,
"description": "Changes the visual style to match the validation status"
Expand Down Expand Up @@ -1770,7 +1770,7 @@
},
{
"name": "variant",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"required": true,
"description": "Changes the visual style to match the validation status"
Expand Down Expand Up @@ -3220,7 +3220,7 @@
},
{
"name": "variant",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"required": true,
"description": "Changes the visual style to match the validation status"
Expand Down Expand Up @@ -3526,7 +3526,7 @@
},
{
"name": "validationStatus",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"description": "Style the input to match the status"
}
Expand Down Expand Up @@ -4050,7 +4050,7 @@
},
{
"name": "validationStatus",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"description": "Style the input to match the status"
},
Expand Down Expand Up @@ -4206,7 +4206,7 @@
},
{
"name": "validationStatus",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"description": "Style the input to match the status"
},
Expand Down
20 changes: 0 additions & 20 deletions script/generate-e2e-tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,10 +326,6 @@ const components = new Map([
id: 'components-checkboxgroup-features--visually-hidden-label',
name: 'Visually Hidden Label',
},
{
id: 'components-checkboxgroup-features--warning',
name: 'Warning',
},
],
},
],
Expand Down Expand Up @@ -954,10 +950,6 @@ const components = new Map([
id: 'components-radiogroup-features--visually-hidden-label',
name: 'Visually Hidden Label',
},
{
id: 'components-radiogroup-features--warning',
name: 'Warning',
},
{
id: 'components-radiogroup-features--with-external-label',
name: 'With External Label',
Expand Down Expand Up @@ -1001,10 +993,6 @@ const components = new Map([
id: 'components-select-features--visually-hidden-label',
name: 'Visually Hidden Label',
},
{
id: 'components-select-features--warning',
name: 'Warning',
},
{
id: 'components-select-features--with-caption',
name: 'With Caption',
Expand Down Expand Up @@ -1137,10 +1125,6 @@ const components = new Map([
id: 'components-textarea-features--visually-hidden-label',
name: 'Visually Hidden Label',
},
{
id: 'components-textarea-features--warning',
name: 'Warning',
},
{
id: 'components-textarea-features--with-caption',
name: 'With Caption',
Expand Down Expand Up @@ -1184,10 +1168,6 @@ const components = new Map([
id: 'components-textinput-features--visually-hidden-label',
name: 'Visually Hidden Label',
},
{
id: 'components-textinput-features--warning',
name: 'Warning',
},
{
id: 'components-textinput-features--with-caption',
name: 'With Caption',
Expand Down
2 changes: 1 addition & 1 deletion src/Checkbox/Checkbox.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
},
{
"name": "validationStatus",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"description": "Only used to inform ARIA attributes.<br /> Individual checkboxes do not have validation styles."
},
Expand Down
2 changes: 1 addition & 1 deletion src/CheckboxGroup/CheckboxGroup.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
},
{
"name": "variant",
"type": "'error' | 'success' | 'warning'",
"type": "'error' | 'success'",
"defaultValue": "",
"required": true,
"description": "Changes the visual style to match the validation status"
Expand Down
19 changes: 0 additions & 19 deletions src/CheckboxGroup/CheckboxGroup.features.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,25 +72,6 @@ export const Error = () => (
</CheckboxGroup>
)

export const Warning = () => (
<CheckboxGroup>
<CheckboxGroup.Label>Choices</CheckboxGroup.Label>
<FormControl>
<Checkbox value="one" defaultChecked />
<FormControl.Label>Choice one</FormControl.Label>
</FormControl>
<FormControl>
<Checkbox value="two" defaultChecked />
<FormControl.Label>Choice two</FormControl.Label>
</FormControl>
<FormControl>
<Checkbox value="three" />
<FormControl.Label>Choice three</FormControl.Label>
</FormControl>
<CheckboxGroup.Validation variant="warning">Warning message</CheckboxGroup.Validation>
</CheckboxGroup>
)

export const Success = () => (
<CheckboxGroup>
<CheckboxGroup.Label>Choices</CheckboxGroup.Label>
Expand Down
2 changes: 1 addition & 1 deletion src/CheckboxGroup/CheckboxGroup.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Playground.argTypes = {
control: {
type: 'radio',
},
options: ['error', 'success', 'warning'],
options: ['error', 'success'],
table: {
category: 'CheckboxGroup.Validation',
},
Expand Down
Loading