Skip to content

fix: validate DatePicker on blur #3189

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: validate DatePicker on blur #3189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions src/components/forms/DatePicker/DatePicker.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,12 +399,14 @@ describe('DatePicker component', () => {
expect(getByTestId('date-picker-external-input')).toBeValid()
})

it('validates an invalid default value', () => {
it('validates an invalid default value', async () => {
const { getByTestId } = renderDatePicker({
defaultValue: '1990-01-01',
minDate: '2020-01-01',
})

await userEvent.click(getByTestId('date-picker-external-input'))
await userEvent.tab()
expect(getByTestId('date-picker-external-input')).toBeInvalid()
})
})
Expand Down Expand Up @@ -538,8 +540,7 @@ describe('DatePicker component', () => {
expect(mockOnBlur).toHaveBeenCalled()
})

// TODO - this is an outstanding difference in behavior from USWDS. Fails because validation happens onChange.
it.skip('typing in the external input does not validate until blurring', async () => {
it('typing in the external input does not validate until blurring', async () => {
const { getByTestId } = renderDatePicker({
minDate: '2021-01-20',
maxDate: '2021-02-14',
Expand All @@ -553,8 +554,7 @@ describe('DatePicker component', () => {
expect(externalInput).toBeInvalid()
})

// TODO - this can be implemented if the above test case is implemented
it.skip('pressing the Enter key in the external input validates the date', async () => {
it('pressing the Enter key in the external input validates the date', async () => {
const { getByTestId } = renderDatePicker({
minDate: '2021-01-20',
maxDate: '2021-02-14',
Expand Down Expand Up @@ -597,6 +597,7 @@ describe('DatePicker component', () => {
'abcdefg... That means the convo is done'
)

await userEvent.tab()
expect(externalInput).toBeInvalid()
expect(externalInput.validationMessage).toEqual(VALIDATION_MESSAGE)
})
Expand All @@ -610,6 +611,7 @@ describe('DatePicker component', () => {
await userEvent.type(externalInput, 'ab/cd/efg')
expect(mockOnChange).toHaveBeenCalledWith('ab/cd/efg')

await userEvent.tab()
expect(externalInput).toBeInvalid()
expect(externalInput.validationMessage).toEqual(VALIDATION_MESSAGE)
})
Expand All @@ -625,12 +627,14 @@ describe('DatePicker component', () => {
await userEvent.type(externalInput, '2/31/2019')
expect(mockOnChange).toHaveBeenCalledWith('2/31/2019')

await userEvent.tab()
expect(externalInput).toBeInvalid()
expect(externalInput.validationMessage).toEqual(VALIDATION_MESSAGE)
await userEvent.click(getByTestId('date-picker-button'))
expect(getByTestId('date-picker-calendar')).toBeVisible()
await userEvent.click(getByLabelText(/^10 February 2019/))
expect(mockOnChange).toHaveBeenCalledWith('02/10/2019')
await userEvent.tab()

await waitFor(() => {
expect(externalInput).toBeValid()
Expand All @@ -651,6 +655,7 @@ describe('DatePicker component', () => {
await userEvent.type(externalInput, '05/16/1988')
expect(mockOnChange).toHaveBeenCalledWith('05/16/1988')

await userEvent.tab()
expect(externalInput).toBeInvalid()
expect(externalInput.validationMessage).toEqual(VALIDATION_MESSAGE)
})
Expand Down
14 changes: 10 additions & 4 deletions src/components/forms/DatePicker/DatePicker.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,18 @@ export const DatePicker = ({

if (isInvalid && !externalInputEl?.current?.validationMessage) {
externalInputEl?.current?.setCustomValidity(VALIDATION_MESSAGE)
externalInputEl?.current?.setAttribute('aria-invalid', 'true')
}

if (
!isInvalid &&
externalInputEl?.current?.validationMessage === VALIDATION_MESSAGE
) {
externalInputEl?.current?.setCustomValidity('')
externalInputEl?.current?.removeAttribute('aria-invalid')
}

externalInputEl?.current?.reportValidity()
}

const handleSelectDate = (dateString: string, closeCalendar = true): void => {
Expand Down Expand Up @@ -170,10 +174,6 @@ export const DatePicker = ({
}
}, [showCalendar])

useEffect(() => {
validateInput()
}, [externalValue, minDate, maxDate])

const handleToggleClick = (): void => {
if (showCalendar) {
// calendar is open, hide it
Expand Down Expand Up @@ -298,9 +298,15 @@ export const DatePicker = ({
setFocusMode(FocusMode.Input)
}}
onBlur={(e): void => {
validateInput()
setFocusMode(FocusMode.None)
onBlur && onBlur(e)
}}
onKeyDown={(e) => {
if (e.key === 'Enter' ) {
externalInputEl.current?.blur()
}
}}
/>
<button
data-testid="date-picker-button"
Expand Down
Loading