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.

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

Clear field error state if the field is cleared #2424

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

beaesguerra
Copy link
Member

Summary:

Previously, if a MultiSelect component had shortcuts enabled, if it was in an error state, the "select all" and "select none" options do not clear the error state. Changing the selected values using these shortcuts now clear the error.

Similarly, if a SearchField component was in an error state, if it is cleared using the clear button, the error would persist. This has been fixed and clearing the value (using the clear button or by erasing the inputted value) now clears the error.

The TextField and TextArea components also clear the error state when the value is cleared, assuming the field is not required.

Issue: WB-1846

Test plan:

MultiSelect

Select none

  1. Navigate to ?path=/story/packages-dropdown-multiselect--error-from-validation and confirm that the shortcuts control is enabled
  2. Press the "Select none" option on the field that has an error already
  3. Verify that the error message is cleared, even after blurring the field (since Jupiter is not selected)

Select all

  1. Navigate to ?path=/story/packages-dropdown-multiselect--error-from-validation and confirm that the shortcuts control is enabled
  2. Press the "Select all" option on the field that has an error already
  3. Verify that the error message is cleared. After blurring the field, the error message should return since Jupiter is selected

SearchField

  1. Navigate to ?path=/story/packages-searchfield--validation
  2. Confirm clearing the field using the clear button or by backspacing the value clears the error state

TextField

  1. Navigate to ?path=/story/packages-form-textfield--instant-validation
  2. Confirm that clearing the field clears the error state in all cases except for when the field is required

TextArea

Same as TextField steps except navigate to ?path=/story/packages-form-textarea--instant-validation

… error when the field is cleared (including when using the clear button in the SearchField or backspacing the value until it's clear)
…ic value instead of an empty field since errors are cleared for empty fields
…ld: Clear error state when field is cleared and it is not required
@beaesguerra beaesguerra self-assigned this Jan 10, 2025
Copy link

changeset-bot bot commented Jan 10, 2025

🦋 Changeset detected

Latest commit: d8e0485

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@khanacademy/wonder-blocks-search-field Patch
@khanacademy/wonder-blocks-form Patch
@khanacademy/wonder-blocks-dropdown Patch
@khanacademy/wonder-blocks-birthday-picker Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Jan 11, 2025

Size Change: +79 B (+0.08%)

Total Size: 96.5 kB

Filename Size Change
packages/wonder-blocks-dropdown/dist/es/index.js 19.1 kB +14 B (+0.07%)
packages/wonder-blocks-form/dist/es/index.js 6.27 kB +65 B (+1.05%)
ℹ️ View Unchanged
Filename Size
packages/wonder-blocks-accordion/dist/es/index.js 3.77 kB
packages/wonder-blocks-banner/dist/es/index.js 1.53 kB
packages/wonder-blocks-birthday-picker/dist/es/index.js 1.77 kB
packages/wonder-blocks-breadcrumbs/dist/es/index.js 887 B
packages/wonder-blocks-button/dist/es/index.js 4.12 kB
packages/wonder-blocks-cell/dist/es/index.js 2.01 kB
packages/wonder-blocks-clickable/dist/es/index.js 3.06 kB
packages/wonder-blocks-core/dist/es/index.js 2.9 kB
packages/wonder-blocks-data/dist/es/index.js 6.24 kB
packages/wonder-blocks-grid/dist/es/index.js 1.36 kB
packages/wonder-blocks-icon-button/dist/es/index.js 2.95 kB
packages/wonder-blocks-icon/dist/es/index.js 871 B
packages/wonder-blocks-labeled-field/dist/es/index.js 72 B
packages/wonder-blocks-layout/dist/es/index.js 1.82 kB
packages/wonder-blocks-link/dist/es/index.js 2.28 kB
packages/wonder-blocks-modal/dist/es/index.js 5.42 kB
packages/wonder-blocks-pill/dist/es/index.js 1.65 kB
packages/wonder-blocks-popover/dist/es/index.js 4.85 kB
packages/wonder-blocks-progress-spinner/dist/es/index.js 1.52 kB
packages/wonder-blocks-search-field/dist/es/index.js 1.36 kB
packages/wonder-blocks-switch/dist/es/index.js 1.92 kB
packages/wonder-blocks-testing-core/dist/es/index.js 3.74 kB
packages/wonder-blocks-testing/dist/es/index.js 1.07 kB
packages/wonder-blocks-theming/dist/es/index.js 693 B
packages/wonder-blocks-timing/dist/es/index.js 1.8 kB
packages/wonder-blocks-tokens/dist/es/index.js 2.36 kB
packages/wonder-blocks-toolbar/dist/es/index.js 905 B
packages/wonder-blocks-tooltip/dist/es/index.js 6.99 kB
packages/wonder-blocks-typography/dist/es/index.js 1.23 kB

compressed-size-action

Copy link
Contributor

A new build was pushed to Chromatic! 🚀

https://5e1bf4b385e3fb0020b7073c-tkfbjwqcmt.chromatic.com/

Chromatic results:

Metric Total
Captured snapshots 164
Tests with visual changes 0
Total stories 511
Inherited (not captured) snapshots [TurboSnap] 208
Tests on the build 372

@@ -357,10 +357,12 @@ const MultiSelect = (props: Props) => {
.filter((option) => !!option && !option.props.disabled)
.map((option) => option.props.value);
onChange(selected);
onSelectedValuesChangeValidation();
Copy link
Member Author

Choose a reason for hiding this comment

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

Since the values change when the Select none / Select all options are picked, we call the onSelectedValuesChangeValidation handler

@@ -729,10 +729,10 @@ describe("Required LabeledTextField", () => {
"test-labeled-text-field-field",
);
textField.focus();
await userEvent.clear(textField);
Copy link
Member Author

Choose a reason for hiding this comment

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

Since we now clear the error state when the field is cleared, this test case can be updated with an example where we update the input value instead of clear it

@beaesguerra beaesguerra marked this pull request as ready for review January 11, 2025 00:05
@khan-actions-bot khan-actions-bot requested a review from a team January 11, 2025 00:06
@khan-actions-bot
Copy link
Contributor

Gerald

Required Reviewers
  • @Khan/wonder-blocks for changes to .changeset/fast-readers-guess.md, .changeset/twenty-ducks-double.md, __docs__/wonder-blocks-dropdown/multi-select.stories.tsx, packages/wonder-blocks-dropdown/src/components/multi-select.tsx, packages/wonder-blocks-form/src/hooks/use-field-validation.ts, packages/wonder-blocks-dropdown/src/components/__tests__/multi-select.test.tsx, packages/wonder-blocks-form/src/components/__tests__/labeled-text-field.test.tsx, packages/wonder-blocks-form/src/components/__tests__/text-area.test.tsx, packages/wonder-blocks-form/src/components/__tests__/text-field.test.tsx, packages/wonder-blocks-form/src/hooks/__tests__/use-field-validation.test.ts, packages/wonder-blocks-search-field/src/components/__tests__/search-field.test.tsx

Don't want to be involved in this pull request? Comment #removeme and we won't notify you of further changes.

Copy link
Contributor

npm Snapshot: Published

🎉 Good news!! We've packaged up the latest commit from this PR (5018e91) and published all packages with changesets to npm.

You can install the packages in webapp by running:

./services/static/dev/tools/deploy_wonder_blocks.js --tag="PR2424"

Packages can also be installed manually by running:

yarn add @khanacademy/wonder-blocks-<package-name>@PR2424

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants