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

fix(input, input-number, input-text, text-area): ensure all applicable props are considered in form validation #8655

Merged
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
10 changes: 10 additions & 0 deletions packages/calcite-components/src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4862,6 +4862,11 @@ export namespace Components {
* Made into a prop for testing purposes only
*/
"messages": TextAreaMessages;
/**
* Specifies the minimum number of characters allowed.
* @mdn [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attr-minlength)
*/
"minLength": number;
/**
* Specifies the name of the component.
* @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attr-name)
Expand Down Expand Up @@ -12354,6 +12359,11 @@ declare namespace LocalJSX {
* Made into a prop for testing purposes only
*/
"messages"?: TextAreaMessages;
/**
* Specifies the minimum number of characters allowed.
* @mdn [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attr-minlength)
*/
"minLength"?: number;
/**
* Specifies the name of the component.
* @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attr-name)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
import { getElementRect, getElementXY, selectText } from "../../tests/utils";
import { letterKeys, numberKeys } from "../../utils/key";
import { locales, numberStringFormatter } from "../../utils/locale";
import { testPostValidationFocusing } from "../input/common/tests";
import { testHiddenInputSyncing, testPostValidationFocusing } from "../input/common/tests";

describe("calcite-input-number", () => {
const delayFor2UpdatesInMs = 200;
Expand Down Expand Up @@ -1752,6 +1752,8 @@ describe("calcite-input-number", () => {
});

testPostValidationFocusing("calcite-input-number");

testHiddenInputSyncing("calcite-input-number");
});

describe("translation support", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ import { InputNumberMessages } from "./assets/input-number/t9n";
import { CSS, SLOTS } from "./resources";
import { getIconScale } from "../../utils/component";
import { Validation } from "../functional/Validation";
import {
NumericInputComponent,
syncHiddenFormInput,
TextualInputComponent,
} from "../input/common/input";

/**
* @slot action - A slot for positioning a button next to the component.
Expand All @@ -86,7 +91,9 @@ export class InputNumber
FormComponent,
InteractiveComponent,
LocalizedComponent,
NumericInputComponent,
T9nComponent,
TextualInputComponent,
LoadableComponent
{
//--------------------------------------------------------------------------
Expand Down Expand Up @@ -798,9 +805,7 @@ export class InputNumber
};

syncHiddenFormInput(input: HTMLInputElement): void {
input.type = "number";
input.min = this.min?.toString(10) ?? "";
input.max = this.max?.toString(10) ?? "";
syncHiddenFormInput("number", this, input);
}

private onHiddenFormInputInput = (event: Event): void => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
t9n,
} from "../../tests/commonTests";
import { selectText } from "../../tests/utils";
import { testPostValidationFocusing } from "../input/common/tests";
import { testHiddenInputSyncing, testPostValidationFocusing } from "../input/common/tests";

describe("calcite-input-text", () => {
describe("labelable", () => {
Expand Down Expand Up @@ -465,6 +465,8 @@ describe("calcite-input-text", () => {
formAssociated("calcite-input-text", { testValue: "test", submitsOnEnter: true });

testPostValidationFocusing("calcite-input-text");

testHiddenInputSyncing("calcite-input-text");
});

describe("translation support", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ import { InputTextMessages } from "./assets/input-text/t9n";
import { CSS, SLOTS } from "./resources";
import { getIconScale } from "../../utils/component";
import { Validation } from "../functional/Validation";
import { syncHiddenFormInput, TextualInputComponent } from "../input/common/input";

/**
* @slot action - A slot for positioning a button next to the component.
Expand All @@ -67,6 +68,7 @@ export class InputText
InteractiveComponent,
LoadableComponent,
LocalizedComponent,
TextualInputComponent,
T9nComponent
{
//--------------------------------------------------------------------------
Expand Down Expand Up @@ -494,13 +496,7 @@ export class InputText
};

syncHiddenFormInput(input: HTMLInputElement): void {
if (this.minLength != null) {
input.minLength = this.minLength;
}

if (this.maxLength != null) {
input.maxLength = this.maxLength;
}
syncHiddenFormInput("text", this, input);
}

private onHiddenFormInputInput = (event: Event): void => {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/* eslint-disable jest/no-conditional-expect -- Using conditional logic in a confined test helper to handle specific scenarios, reducing duplication, balancing test readability and maintainability. **/
import { minMaxLengthTypes, minMaxStepTypes, patternTypes, syncHiddenFormInput } from "./input";

describe("common input utils", () => {
it("syncHiddenFormInput", async () => {
const minMaxLengthTestValues = { minLength: 0, maxLength: 10 };
const patternTestValue = { pattern: "test" };
const minMaxStepTestValues = { min: 0, max: 10, step: 1 };

const allTypes = Array.from(new Set([...minMaxLengthTypes, ...patternTypes, ...minMaxStepTypes]));
const allValueFakeInputComponent = { ...minMaxLengthTestValues, ...minMaxStepTestValues, ...patternTestValue };

const hiddenFormInput = document.createElement("input");

allTypes.forEach((type) => {
syncHiddenFormInput(type, allValueFakeInputComponent, hiddenFormInput);

const expectedType = type === "textarea" ? "text" : type;

expect(hiddenFormInput.type).toBe(expectedType);

if (minMaxStepTypes.includes(type)) {
expect(hiddenFormInput.min).toBe("0");
expect(hiddenFormInput.max).toBe("10");
expect(hiddenFormInput.step).toBe("1");
}

if (minMaxLengthTypes.includes(type)) {
expect(hiddenFormInput.minLength).toBe(0);
expect(hiddenFormInput.maxLength).toBe(10);
}

if (patternTypes.includes(type)) {
expect(hiddenFormInput.pattern).toBe("test");
}
});
});
});
80 changes: 80 additions & 0 deletions packages/calcite-components/src/components/input/common/input.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
export type InputComponent = NumericInputComponent | TextualInputComponent;

export interface NumericInputComponent {
min: number;
max: number;
step: number | "any";
}

export interface TextualInputComponent {
pattern?: string;
minLength: number;
maxLength: number;
Copy link
Member

Choose a reason for hiding this comment

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

We should probably deprecate minLength and maxLength on calcite-input-number. That's on me - I didn't check the constraint validation doc when I ported the input code over to the new component.

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreed. Good catch. 🎣

}

/**
* Exported for testing purposes only
*/
export const minMaxStepTypes = ["date", "datetime-local", "month", "number", "range", "time", "week"];

/**
* Exported for testing purposes only
*/
export const patternTypes = ["email", "password", "search", "tel", "text", "url"];

/**
* Exported for testing purposes only
*/
export const minMaxLengthTypes = ["email", "password", "search", "tel", "text", "textarea", "url"];

function updateConstraintValidation(
inputComponent: InputComponent,
input: HTMLInputElement,
propName: string,
matchesType: boolean,
): void {
const attributeName = propName.toLowerCase();
const value = inputComponent[propName];

if (matchesType && value != null) {
input.setAttribute(attributeName, `${value}`);
} else {
// we remove the attribute to ensure validation-constraints are properly reset
input.removeAttribute(attributeName);
}
}

/**
* Synchronizes the hidden form input with the validation-related input properties.
*
* Note: loss of precision is expected due to the hidden input's value and validation-constraint props being strings.
*
* @param type - The input type.
* @param inputComponent
* @param hiddenFormInput
*/
export function syncHiddenFormInput(
type: HTMLInputElement["type"] | "textarea",
inputComponent: InputComponent,
hiddenFormInput: HTMLInputElement,
): void {
hiddenFormInput.type = type === "textarea" ? "text" : type;

const isMinMaxStepType = minMaxStepTypes.includes(type);
const numericInputComponent = inputComponent as NumericInputComponent;

updateConstraintValidation(numericInputComponent, hiddenFormInput, "min", isMinMaxStepType);
updateConstraintValidation(numericInputComponent, hiddenFormInput, "max", isMinMaxStepType);
updateConstraintValidation(numericInputComponent, hiddenFormInput, "step", isMinMaxStepType);

const isMinMaxLengthType = minMaxLengthTypes.includes(type);

const textualInputComponent = inputComponent as TextualInputComponent;

updateConstraintValidation(textualInputComponent, hiddenFormInput, "minLength", isMinMaxLengthType);
updateConstraintValidation(textualInputComponent, hiddenFormInput, "maxLength", isMinMaxLengthType);

const isPatternType = patternTypes.includes(type);

updateConstraintValidation(textualInputComponent, hiddenFormInput, "pattern", isPatternType);
}
69 changes: 69 additions & 0 deletions packages/calcite-components/src/components/input/common/tests.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/* eslint-disable jest/no-conditional-expect -- Using conditional logic in a confined test helper to handle specific scenarios, reducing duplication, balancing test readability and maintainability. **/

import { newE2EPage } from "@stencil/core/testing";
import { isElementFocused } from "../../../tests/utils";
import { hiddenFormInputSlotName } from "../../../utils/form";
Expand Down Expand Up @@ -46,3 +48,70 @@ export function testPostValidationFocusing(
expect(await input.getProperty("value")).toBe(expectedValue);
});
}

export function testHiddenInputSyncing(
inputTag: Extract<
keyof JSX.IntrinsicElements,
"calcite-input" | "calcite-input-text" | "calcite-input-number" | "calcite-text-area"
>,
): void {
it("syncs hidden input with the input component", async () => {
const page = await newE2EPage();
await page.setContent(html`
<form>
<${inputTag} name="form-name"></${inputTag}>
</form>
`);
const input = await page.find(inputTag);
const hiddenInput = await page.find(`input[slot=${hiddenFormInputSlotName}]`);

// intentionally setting all props regardless of type for testing purposes
input.setProperty("min", 0);
input.setProperty("max", 10);
input.setProperty("step", 1);
input.setProperty("pattern", "test");
input.setProperty("minLength", 0);
input.setProperty("maxLength", 10);
await page.waitForChanges();

async function assertTextProps(): Promise<void> {
expect(await hiddenInput.getProperty("type")).toBe("text");
expect(await hiddenInput.getProperty("min")).toBe("");
expect(await hiddenInput.getProperty("max")).toBe("");
expect(await hiddenInput.getProperty("pattern")).toBe("test");
expect(await hiddenInput.getProperty("minLength")).toBe(0);
expect(await hiddenInput.getProperty("maxLength")).toBe(10);
}

async function assertNumericProps(): Promise<void> {
expect(await hiddenInput.getProperty("type")).toBe("number");
expect(await hiddenInput.getProperty("min")).toBe("0");
expect(await hiddenInput.getProperty("max")).toBe("10");
expect(await hiddenInput.getProperty("pattern")).toBe("");
expect(await hiddenInput.getProperty("minLength")).toBe(-1);
expect(await hiddenInput.getProperty("maxLength")).toBe(-1);
}

if (inputTag === "calcite-input") {
// testing subset of types

await input.setProperty("type", "text");
await page.waitForChanges();

await assertTextProps();

await input.setProperty("type", "number");
await page.waitForChanges();

await assertNumericProps();
return;
}

if (inputTag === "calcite-input-text" || inputTag === "calcite-text-area") {
await assertTextProps();
return;
}

await assertNumericProps();
});
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { letterKeys, numberKeys } from "../../utils/key";
import { locales, numberStringFormatter } from "../../utils/locale";
import { getElementRect, getElementXY, selectText } from "../../tests/utils";
import { KeyInput } from "puppeteer";
import { testPostValidationFocusing } from "./common/tests";
import { testHiddenInputSyncing, testPostValidationFocusing } from "./common/tests";

describe("calcite-input", () => {
const delayFor2UpdatesInMs = 200;
Expand Down Expand Up @@ -2057,6 +2057,8 @@ describe("calcite-input", () => {
}

testPostValidationFocusing("calcite-input");

testHiddenInputSyncing("calcite-input");
});

describe("translation support", () => {
Expand Down
22 changes: 5 additions & 17 deletions packages/calcite-components/src/components/input/input.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ import { InputPlacement, NumberNudgeDirection, SetValueOrigin } from "./interfac
import { CSS, INPUT_TYPE_ICONS, SLOTS } from "./resources";
import { getIconScale } from "../../utils/component";
import { Validation } from "../functional/Validation";
import { NumericInputComponent, syncHiddenFormInput, TextualInputComponent } from "./common/input";

/**
* @slot action - A slot for positioning a `calcite-button` next to the component.
Expand All @@ -88,7 +89,9 @@ export class Input
InteractiveComponent,
T9nComponent,
LocalizedComponent,
LoadableComponent
LoadableComponent,
NumericInputComponent,
TextualInputComponent
{
//--------------------------------------------------------------------------
//
Expand Down Expand Up @@ -884,22 +887,7 @@ export class Input
};

syncHiddenFormInput(input: HTMLInputElement): void {
const { type } = this;

input.type = type;

if (type === "number") {
input.min = this.min?.toString(10) ?? "";
input.max = this.max?.toString(10) ?? "";
} else if (type === "text") {
if (this.minLength != null) {
input.minLength = this.minLength;
}

if (this.maxLength != null) {
input.maxLength = this.maxLength;
}
}
syncHiddenFormInput(this.type, this, input);
}

private onHiddenFormInputInput = (event: Event): void => {
Expand Down
Loading
Loading