Skip to content

feat(input-date-picker, input-time-picker): support form validation for min/max constraints #9677

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

Merged
merged 6 commits into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions packages/calcite-components/src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2741,6 +2741,11 @@ export namespace Components {
* The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any.
*/
"form": string;
/**
* Specifies the maximum value.
* @mdn [max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time#max)
*/
"max": string;
/**
* Use this property to override individual strings used by the component.
*/
Expand All @@ -2749,6 +2754,11 @@ export namespace Components {
* Made into a prop for testing purposes only
*/
"messages": InputTimePickerMessages;
/**
* Specifies the minimum value.
* @mdn [min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time#min)
*/
"min": string;
/**
* Specifies the name of the component on form submission.
*/
Expand Down Expand Up @@ -10617,6 +10627,11 @@ declare namespace LocalJSX {
* The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any.
*/
"form"?: string;
/**
* Specifies the maximum value.
* @mdn [max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time#max)
*/
"max"?: string;
/**
* Use this property to override individual strings used by the component.
*/
Expand All @@ -10625,6 +10640,11 @@ declare namespace LocalJSX {
* Made into a prop for testing purposes only
*/
"messages"?: InputTimePickerMessages;
/**
* Specifies the minimum value.
* @mdn [min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time#min)
*/
"min"?: string;
/**
* Specifies the name of the component on form submission.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -760,13 +760,19 @@ describe("calcite-input-date-picker", () => {

describe("is form-associated", () => {
describe("supports single value", () => {
formAssociated("calcite-input-date-picker", { testValue: "1985-03-23", submitsOnEnter: true, validation: true });
formAssociated("calcite-input-date-picker", {
testValue: "1985-03-23",
submitsOnEnter: true,
validation: true,
inputType: "date",
});
});

describe("supports range", () => {
formAssociated(`<calcite-input-date-picker range name="calcite-input-date-picker"></calcite-input-date-picker>`, {
testValue: ["1985-03-23", "1985-10-30"],
submitsOnEnter: true,
inputType: "date",
});
});
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ import { guid } from "../../utils/guid";
import { componentOnReady, getIconScale } from "../../utils/component";
import { Status } from "../interfaces";
import { Validation } from "../functional/Validation";
import { syncHiddenFormInput } from "../input/common/input";
import { normalizeToCurrentCentury, isTwoDigitYear } from "./utils";
import { InputDatePickerMessages } from "./assets/input-date-picker/t9n";
import { CSS } from "./resources";
Expand Down Expand Up @@ -854,6 +855,10 @@ export class InputDatePicker
this.datePickerEl.reset();
}

syncHiddenFormInput(input: HTMLInputElement): void {
syncHiddenFormInput("date", this, input);
}

setStartInput = (el: HTMLCalciteInputElement): void => {
this.startInput = el;
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ describe("calcite-input-time-picker", () => {
submitsOnEnter: true,
validation: true,
validUserInputTestValue: "03:23 AM",
inputType: "time",
});
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ import { decimalPlaces } from "../../utils/math";
import { getIconScale } from "../../utils/component";
import { Validation } from "../functional/Validation";
import { focusFirstTabbable } from "../../utils/dom";
import { syncHiddenFormInput } from "../input/common/input";
import { CSS } from "./resources";
import { InputTimePickerMessages } from "./assets/input-time-picker/t9n";

Expand Down Expand Up @@ -231,6 +232,20 @@ export class InputTimePicker
}
}

/**
* Specifies the maximum value.
*
* @mdn [max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time#max)
*/
@Prop({ reflect: true }) max: string;

/**
* Specifies the minimum value.
*
* @mdn [min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time#min)
*/
@Prop({ reflect: true }) min: string;

/**
* Use this property to override individual strings used by the component.
*/
Expand Down Expand Up @@ -559,6 +574,10 @@ export class InputTimePicker
this.calciteInputTimePickerClose.emit();
}

syncHiddenFormInput(input: HTMLInputElement): void {
syncHiddenFormInput("time", this, input);
}

private delocalizeTimeString(value: string): string {
// we need to set the corresponding locale before parsing, otherwise it defaults to English (possible dayjs bug)
dayjs.locale(this.effectiveLocale.toLowerCase());
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
export type InputComponent = NumericInputComponent | TextualInputComponent;
export type InputComponent = NumericInputComponent | TextualInputComponent | DateTimeInputComponent;

export interface DateTimeInputComponent {
min: string;
max: string;
}

export interface NumericInputComponent {
min: number;
Expand Down
29 changes: 26 additions & 3 deletions packages/calcite-components/src/demos/validation.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@
padding: var(--calcite-spacing-md);
}

#when {
display: flex;
}

#whenDate,
#whenTime {
align-self: center;
width: 50%;
}

/* Progress bar */
#progress {
position: fixed;
Expand Down Expand Up @@ -147,11 +157,24 @@ <h1 style="margin: 0 auto; text-align: center">Form Validation</h1>
</calcite-label>
</li>

<!-- Date picker -->
<!-- Date and time pickers -->
<li>
<calcite-label>
When did you hear about Calcite components?
<calcite-input-date-picker id="when" name="when" required></calcite-input-date-picker>
<div id="when">
<calcite-input-date-picker
id="whenDate"
name="whenDate"
max="2024-07-01"
required
></calcite-input-date-picker>
<calcite-input-time-picker
id="whenTime"
name="whenTime"
max="23:11"
required
></calcite-input-time-picker>
</div>
</calcite-label>
</li>

Expand Down Expand Up @@ -449,7 +472,7 @@ <h1 style="margin: 0 auto; text-align: center">Form Validation</h1>
});

// Date picker
const datePicker = document.getElementById("when");
const datePicker = document.getElementById("whenDate");
datePicker.maxAsDate = new Date();
datePicker.min = "2021-01-01";

Expand Down
Loading