@dxc-technology/halstack-react 0.0.0-dedf1af → 0.0.0-dfcca07

package/text-input/TextInput.stories.tsx

@@ -0,0 +1,456 @@
+import React from "react";
+import { userEvent, within, waitFor } from "@storybook/testing-library";
+import { fireEvent } from "@testing-library/react";
+import { BackgroundColorProvider } from "../BackgroundColorContext";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DarkContainer from "../../.storybook/components/DarkSection";
+import DxcTextInput from "./TextInput";
+
+export default {
+  title: "Text input",
+  component: DxcTextInput,
+};
+
+const action = {
+  onClick: () => {},
+  icon: (
+    <svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 0 24 24" width="24px" fill="currentColor">
+      <path d="M0 0h24v24H0V0z" fill="none" />
+      <path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z" />
+    </svg>
+  ),
+};
+
+const actionLargeIcon = {
+  onClick: () => {},
+  icon: (
+    <svg xmlns="http://www.w3.org/2000/svg" height="48px" viewBox="0 0 24 24" width="48px" fill="currentColor">
+      <path d="M0 0h24v24H0V0z" fill="none" />
+      <path d="M11.99 2C6.47 2 2 6.48 2 12s4.47 10 9.99 10C17.52 22 22 17.52 22 12S17.52 2 11.99 2zM12 20c-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8-3.58 8-8 8zm.5-13H11v6l5.25 3.15.75-1.23-4.5-2.67z" />
+    </svg>
+  ),
+};
+
+const country = ["Afghanistan"];
+const countries = [
+  "Afghanistan",
+  "Albania",
+  "Algeria",
+  "Andorra Andorra Andorra Andorra Andorra Andorra Andorra Andorra",
+  "Angola",
+  "Antigua and Barbuda Antigua and Barbuda Antigua and Barbuda",
+  "Bahamas",
+  "Bahrain",
+  "Bangladesh",
+  "Barbados",
+  "Cabo Verde",
+  "Cambodia",
+  "Cameroon",
+  "Canada",
+  "Cayman Islands, The",
+  "Central African Republic",
+  "Chad",
+  "Democratic Republic of the Congo",
+  "Dominican Republic",
+  "Dominica",
+  "Denmark",
+  "Djibouti",
+];
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered input" theme="light" level={4} />
+      <DxcTextInput label="Text input" />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-focus-within">
+      <Title title="Focused input" theme="light" level={4} />
+      <DxcTextInput label="Text input" />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered action" theme="light" level={4} />
+      <DxcTextInput label="Text input" value="Text" clearable />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Without label" theme="light" level={4} />
+      <DxcTextInput />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With label and placeholder" theme="light" level={4} />
+      <DxcTextInput label="Text input" placeholder="Placeholder" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Helper text, optional, and clearable" theme="light" level={4} />
+      <DxcTextInput label="Text input" clearable value="Text" helperText="Help message" optional />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Clearable and large icon action" theme="light" level={4} />
+      <DxcTextInput
+        label="Text input"
+        value="Text text text text text text text text text text"
+        clearable
+        action={actionLargeIcon}
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Prefix" theme="light" level={4} />
+      <DxcTextInput label="With prefix" prefix="+34" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Suffix and action" theme="light" level={4} />
+      <DxcTextInput label="With suffix" suffix="USD" action={action} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Invalid" theme="light" level={4} />
+      <DxcTextInput
+        label="Error text input"
+        helperText="Help message"
+        error="Error message."
+        value="Text"
+        clearable
+        optional
+        action={action}
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled and placeholder" theme="light" level={4} />
+      <DxcTextInput label="Disabled text input" disabled placeholder="Placeholder" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled, helper text, optional, value and action" theme="light" level={4} />
+      <DxcTextInput
+        label="Disabled text input"
+        helperText="Help message"
+        disabled
+        optional
+        value="Text"
+        action={action}
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled with prefix and suffix" theme="light" level={4} />
+      <DxcTextInput
+        label="Disabled text input"
+        helperText="Help message"
+        disabled
+        optional
+        prefix="+34"
+        suffix="USD"
+        value="Text"
+        action={action}
+      />
+    </ExampleContainer>
+    <BackgroundColorProvider color="#333333">
+      <DarkContainer>
+        <Title title="Dark" theme="dark" level={2} />
+        <ExampleContainer pseudoState="pseudo-hover">
+          <Title title="Hovered" theme="dark" level={4} />
+          <DxcTextInput label="Text input" />
+        </ExampleContainer>
+        <ExampleContainer pseudoState="pseudo-focus-within">
+          <Title title="Focused" theme="dark" level={4} />
+          <DxcTextInput label="Text input" />
+        </ExampleContainer>
+        <ExampleContainer pseudoState="pseudo-hover">
+          <Title title="Hovered action" theme="dark" level={4} />
+          <DxcTextInput label="Text input" value="Text" clearable />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Helper text, placeholder, optional and action" theme="dark" level={4} />
+          <DxcTextInput
+            label="Text input"
+            helperText="Help message"
+            placeholder="Placeholder"
+            clearable
+            optional
+            action={action}
+          />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Helper text, clearable value, error and action" theme="dark" level={4} />
+          <DxcTextInput
+            label="Text input"
+            helperText="Help message"
+            error="Error message."
+            value="Text"
+            clearable
+            action={action}
+          />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Prefix and suffix" theme="dark" level={4} />
+          <DxcTextInput label="With prefix and suffix" prefix="+34" suffix="USD" />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled and placeholder" theme="dark" level={4} />
+          <DxcTextInput label="Disabled text input" disabled placeholder="Placeholder" />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled, helper text, optional, value and action" theme="dark" level={4} />
+          <DxcTextInput
+            label="Disabled text input"
+            helperText="Help message"
+            disabled
+            optional
+            value="Text"
+            action={action}
+          />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled with prefix and suffix" theme="dark" level={4} />
+          <DxcTextInput
+            label="Disabled text input"
+            helperText="Help message"
+            disabled
+            optional
+            prefix="+34"
+            suffix="USD"
+            value="Text"
+            action={action}
+          />
+        </ExampleContainer>
+      </DarkContainer>
+    </BackgroundColorProvider>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcTextInput label="Xxsmall" margin="xxsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcTextInput label="Xsmall" margin="xsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcTextInput label="Small" margin="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcTextInput label="Medium" margin="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcTextInput label="Large" margin="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcTextInput label="Xlarge" margin="xlarge" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcTextInput label="Xxlarge" margin="xxlarge" />
+    </ExampleContainer>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Small size" theme="light" level={4} />
+      <DxcTextInput label="Small" size="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium size" theme="light" level={4} />
+      <DxcTextInput label="Medium" size="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large size" theme="light" level={4} />
+      <DxcTextInput label="Large" size="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="FillParent size" theme="light" level={4} />
+      <DxcTextInput label="FillParent" size="fillParent" />
+    </ExampleContainer>
+  </>
+);
+
+const FocusedActionTextInput = () => (
+  <ExampleContainer>
+    <Title title="Focused action" theme="light" level={4} />
+    <DxcTextInput label="Text input" action={action} clearable />
+  </ExampleContainer>
+);
+
+const ActivedActionTextInput = () => (
+  <ExampleContainer pseudoState="pseudo-active">
+    <Title title="Actived action" theme="light" level={4} />
+    <DxcTextInput label="Text input" action={action} clearable />
+  </ExampleContainer>
+);
+
+const ShowOptionsAutosuggest = () => (
+  <ExampleContainer expanded>
+    <Title title="Show options" theme="light" level={4} />
+    <DxcTextInput label="Text input" suggestions={countries} clearable />
+  </ExampleContainer>
+);
+
+const HoveredOptionAutosuggest = () => (
+  <ExampleContainer expanded pseudoState="pseudo-hover">
+    <Title title="Hovered option" theme="light" level={4} />
+    <DxcTextInput label="Text input" suggestions={country} clearable />
+  </ExampleContainer>
+);
+
+const FocusedOptionAutosuggest = () => (
+  <ExampleContainer expanded>
+    <Title title="Focused option" theme="light" level={4} />
+    <DxcTextInput label="Text input" suggestions={country} clearable />
+  </ExampleContainer>
+);
+
+const ActivedOptionAutosuggest = () => (
+  <ExampleContainer expanded pseudoState="pseudo-active">
+    <Title title="Actived option" theme="light" level={4} />
+    <DxcTextInput label="Text input" suggestions={country} clearable />
+  </ExampleContainer>
+);
+
+const FocusedActionTextInputOnDark = () => (
+  <BackgroundColorProvider color="#333333">
+    <DarkContainer>
+      <ExampleContainer>
+        <Title title="Focused action" theme="dark" level={4} />
+        <DxcTextInput label="Text input" action={action} clearable />
+      </ExampleContainer>
+    </DarkContainer>
+  </BackgroundColorProvider>
+);
+
+const ActivedActionTextInputOnDark = () => (
+  <BackgroundColorProvider color="#333333">
+    <DarkContainer>
+      <ExampleContainer pseudoState="pseudo-active">
+        <Title title="Actived action" theme="dark" level={4} />
+        <DxcTextInput label="Text input" action={action} clearable />
+      </ExampleContainer>
+    </DarkContainer>
+  </BackgroundColorProvider>
+);
+
+const ShowOptionsAutosuggestOnDark = () => (
+  <BackgroundColorProvider color="#333333">
+    <DarkContainer>
+      <ExampleContainer expanded>
+        <Title title="Show options" theme="dark" level={4} />
+        <DxcTextInput label="Text input" suggestions={countries} clearable />
+      </ExampleContainer>
+    </DarkContainer>
+  </BackgroundColorProvider>
+);
+
+const HoveredActionAutosuggestOnDark = () => (
+  <BackgroundColorProvider color="#333333">
+    <DarkContainer>
+      <ExampleContainer expanded pseudoState="pseudo-hover">
+        <Title title="Hovered option" theme="dark" level={4} />
+        <DxcTextInput label="Text input" suggestions={country} clearable />
+      </ExampleContainer>
+    </DarkContainer>
+  </BackgroundColorProvider>
+);
+
+const FocusedOptionAutosuggestOnDark = () => (
+  <BackgroundColorProvider color="#333333">
+    <DarkContainer>
+      <ExampleContainer expanded>
+        <Title title="Focused option" theme="dark" level={4} />
+        <DxcTextInput label="Text input" suggestions={country} clearable />
+      </ExampleContainer>
+    </DarkContainer>
+  </BackgroundColorProvider>
+);
+
+const ActivedOptionAutosuggestOnDark = () => (
+  <BackgroundColorProvider color="#333333">
+    <DarkContainer>
+      <ExampleContainer expanded pseudoState="pseudo-active">
+        <Title title="Actived option" theme="dark" level={4} />
+        <DxcTextInput label="Text input" suggestions={country} clearable />
+      </ExampleContainer>
+    </DarkContainer>
+  </BackgroundColorProvider>
+);
+
+export const FocusedAction = FocusedActionTextInput.bind({});
+FocusedAction.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const action = canvas.getByRole("button");
+  await action.focus();
+};
+
+export const ActivedAction = ActivedActionTextInput.bind({});
+ActivedAction.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const action = canvas.getByRole("button");
+  await userEvent.click(action);
+};
+
+export const ShowOptions = ShowOptionsAutosuggest.bind({});
+ShowOptions.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+};
+
+export const HoveredOption = HoveredOptionAutosuggest.bind({});
+HoveredOption.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+};
+
+export const FocusedOption = FocusedOptionAutosuggest.bind({});
+FocusedOption.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+  fireEvent.keyDown(autosuggest, { key: "ArrowDown", code: "ArrowDown", keyCode: 40, charCode: 40 });
+};
+
+export const ActivedOption = ActivedOptionAutosuggest.bind({});
+ActivedOption.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+};
+
+export const FocusedActionOnDark = FocusedActionTextInputOnDark.bind({});
+FocusedActionOnDark.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const action = canvas.getByRole("button");
+  await action.focus();
+};
+
+export const ActivedActionOnDark = ActivedActionTextInputOnDark.bind({});
+ActivedActionOnDark.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const action = canvas.getByRole("button");
+  await userEvent.click(action);
+};
+
+export const ShowOptionsOnDark = ShowOptionsAutosuggestOnDark.bind({});
+ShowOptionsOnDark.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+};
+
+export const HoveredActionOnDark = HoveredActionAutosuggestOnDark.bind({});
+HoveredActionOnDark.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+};
+
+export const FocusedOptionOnDark = FocusedOptionAutosuggestOnDark.bind({});
+FocusedOptionOnDark.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+  fireEvent.keyDown(autosuggest, { key: "ArrowDown", code: "ArrowDown", keyCode: 40, charCode: 40 });
+};
+
+export const ActivedOptionOnDark = ActivedOptionAutosuggestOnDark.bind({});
+ActivedOptionOnDark.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const autosuggest = canvas.getByRole("combobox");
+  await userEvent.click(autosuggest);
+};

package/text-input/types.d.ts

@@ -0,0 +1,159 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type SVG = React.SVGProps<SVGSVGElement> | React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
+declare type Action = {
+    /**
+     * This function will be called when the user clicks the action.
+     */
+    onClick: (event: React.MouseEvent<HTMLButtonElement>) => void;
+    /**
+     * Icon to be shown in the action.
+     */
+    icon: string | SVG;
+    /**
+     * Title of the action.
+     */
+    title?: string;
+};
+declare type Props = {
+    /**
+     * Text to be placed above the input. This label will be used as the aria-label attribute of the list of suggestions.
+     */
+    label?: string;
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
+     */
+    value?: string;
+    /**
+     * Helper text to be placed above the input.
+     */
+    helperText?: string;
+    /**
+     * Text to be put as placeholder of the input.
+     */
+    placeholder?: string;
+    /**
+     * Action to be shown in the input. This is an object composed of an onClick function and an icon,
+     * being the latter either an inline svg or a URL to the image.
+     */
+    action?: Action;
+    /**
+     * If true, the input will have an action to clear the entered value.
+     */
+    clearable?: boolean;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * If true, the input will be optional, showing '(Optional)'
+     * next to the label. Otherwise, the field will be considered required and an error will be
+     * passed as a parameter to the OnBlur and onChange functions when it has
+     * not been filled.
+     */
+    optional?: boolean;
+    /**
+     * Prefix to be placed before the input value.
+     */
+    prefix?: string;
+    /**
+     * Suffix to be placed after the input value.
+     */
+    suffix?: string;
+    /**
+     * This function will be called when the user types within the input
+     * element of the component. An object including the current value and
+     * the error (if the value entered is not valid) will be passed to this
+     * function. If there is no error, error will be null.
+     */
+    onChange?: (val: {
+        value: string;
+        error: string | null;
+    }) => void;
+    /**
+     * This function will be called when the input element loses the focus.
+     * An object including the input value and the error (if the value
+     * entered is not valid) will be passed to this function. If there is no error,
+     * error will be null.
+     */
+    onBlur?: (val: {
+        value: string;
+        error: string | null;
+    }) => void;
+    /**
+     * If it is defined, the component will change its appearance, showing
+     * the error below the input component. If it is not defined, the error
+     * messages will be managed internally, but never displayed on its own.
+     */
+    error?: string;
+    /**
+     * These are the options to be displayed as suggestions. It can be either an array or a function:
+     *    - Array:    Array of options that will be filtered by the component.
+     *    - Function: This function will be called when the user changes the value, we will send as a parameter the new value;
+     *                apart from that this function should return one promise on which we should make 'then' to get the suggestions filtered.
+     */
+    suggestions?: string[] | ((value: string) => Promise<string[]>);
+    /**
+     * Regular expression that defines the valid format allowed by the input.
+     * This will be checked both when the input element loses the focus and
+     * while typing within it. If the string entered does not match the
+     * pattern, the onBlur and onChange functions will be called with the
+     * current value and an internal error informing that this value does not
+     * match the pattern. If the pattern is met, the error parameter of both
+     * events will be null.
+     */
+    pattern?: string;
+    /**
+     * Specifies the minimun length allowed by the input.
+     * This will be checked both when the input element loses the
+     * focus and while typing within it. If the string entered does not
+     * comply the minimum length, the onBlur and onChange functions will be called
+     * with the current value and an internal error informing that the value
+     * length does not comply the specified range. If a valid length is
+     * reached, the error parameter of both events will be null.
+     */
+    minLength?: number;
+    /**
+     * Specifies the maximum length allowed by the input.
+     * This will be checked both when the input element loses the
+     * focus and while typing within it. If the string entered does not
+     * comply the maximum length, the onBlur and onChange functions will be called
+     * with the current value and an internal error informing that the value
+     * length does not comply the specified range. If a valid length is
+     * reached, the error parameter of both events will be null.
+     */
+    maxLength?: number;
+    /**
+     * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the input value.
+     * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
+     */
+    autocomplete?: string;
+    /**
+     * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
+     * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
+     */
+    margin?: Space | Margin;
+    /**
+     * Size of the component ('small' | 'medium' | 'large' | 'fillParent').
+     */
+    size?: "small" | "medium" | "large" | "fillParent";
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+/**
+ * Reference to the component.
+ */
+export declare type RefType = HTMLDivElement;
+export default Props;

package/text-input/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});