@dxc-technology/halstack-react 0.0.0-9253572 → 0.0.0-9282b45

package/accordion/Accordion.stories.tsx

@@ -0,0 +1,306 @@
+import React from "react";
+import DxcAccordion from "./Accordion";
+import DxcHeading from "../heading/Heading";
+import DxcTextInput from "../text-input/TextInput";
+import DxcButton from "../button/Button";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { HalstackProvider } from "../HalstackContext";
+
+export default {
+  title: "Accordion",
+  component: DxcAccordion,
+};
+
+const folderIcon = (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    enableBackground="new 0 0 24 24"
+    height="24px"
+    viewBox="0 0 24 24"
+    width="24px"
+    fill="currentColor"
+  >
+    <g>
+      <rect fill="none" height="24" width="24" />
+    </g>
+    <g>
+      <path d="M20,6h-8l-2-2H4C2.9,4,2.01,4.9,2.01,6L2,18c0,1.1,0.9,2,2,2h16c1.1,0,2-0.9,2-2V8C22,6.9,21.1,6,20,6z M16,16h2v-2h-2v-2 h2v-2h-2V8h4v10h-4V16z M16,16h-2v2H4V6h5.17l2,2H14v2h2v2h-2v2h2V16z" />
+    </g>
+  </svg>
+);
+
+const thumbIcon = (
+  <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="M1 21h4V9H1v12zm22-11c0-1.1-.9-2-2-2h-6.31l.95-4.57.03-.32c0-.41-.17-.79-.44-1.06L14.17 1 7.59 7.59C7.22 7.95 7 8.45 7 9v10c0 1.1.9 2 2 2h9c.83 0 1.54-.5 1.84-1.22l3.02-7.05c.09-.23.14-.47.14-.73v-2z" />
+  </svg>
+);
+
+const advancedTheme = {
+  accordion: {
+    backgroundColor: "#000000",
+    assistiveTextFontColor: "#ffffff",
+    titleLabelFontColor: "#ffffff",
+    arrowColor: "#5f249f",
+    iconColor: "#5f249f",
+  },
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Component anatomy" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="With label" theme="light" level={4} />
+      <DxcAccordion label="Accordion">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With assistive text" theme="light" level={4} />
+      <DxcAccordion label="Accordion" assistiveText="Assistive text">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With icon" theme="light" level={4} />
+      <DxcAccordion label="Accordion" assistiveText="Assistive text" icon={folderIcon}>
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With bigger icon 48x48" theme="light" level={4} />
+      <DxcAccordion label="Accordion" assistiveText="Assistive text" icon={thumbIcon}>
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <Title title="States" theme="light" level={2} />
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="Focused" theme="light" level={4} />
+      <DxcAccordion label="Focused">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered" theme="light" level={4} />
+      <DxcAccordion label="Hovered">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-active">
+      <Title title="Active" theme="light" level={4} />
+      <DxcAccordion label="Active">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled" theme="light" level={4} />
+      <DxcAccordion label="Disabled" assistiveText="Assistive text" icon={folderIcon} disabled>
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Background color provider over accordion content" theme="light" level={4} />
+      <HalstackProvider advancedTheme={advancedTheme}>
+        <DxcAccordion
+          label="Dark Accordion"
+          defaultIsExpanded
+          assistiveText="Assistive text"
+          icon={folderIcon}
+          padding="medium"
+        >
+          <div style={{ display: "flex", flexDirection: "column", gap: "36px" }}>
+            <DxcTextInput
+              label="Label"
+              helperText="HelperText"
+              placeholder="Placeholder"
+              size="fillParent"
+            />
+            <DxcButton label="Submit" size="medium" />
+          </div>
+        </DxcAccordion>
+      </HalstackProvider>
+    </ExampleContainer>
+    <Title title="Paddings" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall padding" theme="light" level={4} />
+      <DxcAccordion label="Xxsmall padding" defaultIsExpanded padding="xxsmall">
+        <div>
+          <DxcHeading level={5} text="Content header" margin={{ bottom: "xxsmall" }} />
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+          est laborum.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall padding" theme="light" level={4} />
+      <DxcAccordion label="Xsmall padding" defaultIsExpanded padding="xsmall">
+        <div>
+          <DxcHeading level={5} text="Content header" margin={{ bottom: "xxsmall" }} />
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+          est laborum.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small padding" theme="light" level={4} />
+      <DxcAccordion label="Small padding" defaultIsExpanded padding="small">
+        <div>
+          <DxcHeading level={5} text="Content header" margin={{ bottom: "xxsmall" }} />
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+          est laborum.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium padding" theme="light" level={4} />
+      <DxcAccordion label="Medium padding" defaultIsExpanded padding="medium">
+        <div>
+          <DxcHeading level={5} text="Content header" margin={{ bottom: "xxsmall" }} />
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+          est laborum.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large padding" theme="light" level={4} />
+      <DxcAccordion label="Large padding" defaultIsExpanded padding="large">
+        <div>
+          <DxcHeading level={5} text="Content header" margin={{ bottom: "xxsmall" }} />
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+          est laborum.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge padding" theme="light" level={4} />
+      <DxcAccordion label="Xlarge padding" defaultIsExpanded padding="xlarge">
+        <div>
+          <DxcHeading level={5} text="Content header" margin={{ bottom: "xxsmall" }} />
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+          est laborum.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge padding" theme="light" level={4} />
+      <DxcAccordion label="Xxlarge padding" defaultIsExpanded padding="xxlarge">
+        <div>
+          <DxcHeading level={5} text="Content header" margin={{ bottom: "xxsmall" }} />
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+          est laborum.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcAccordion label="Xxsmall margin" margin="xxsmall">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcAccordion label="Xsmall margin" margin="xsmall">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcAccordion label="Small margin" margin="small">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcAccordion label="Medium margin" margin="medium">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcAccordion label="Large margin" margin="large">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcAccordion label="Xlarge margin" margin="xlarge">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcAccordion label="Xxlarge margin" margin="xxlarge">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAccordion>
+      <hr />
+    </ExampleContainer>
+  </>
+);

package/accordion/Accordion.test.js

@@ -0,0 +1,71 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _Accordion = _interopRequireDefault(require("./Accordion"));
+
+describe("Accordion component tests", function () {
+  test("Renders with correct aria accessibility attributes", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Accordion["default"], {
+      label: "Accordion",
+      defaultIsExpanded: true
+    }, /*#__PURE__*/_react["default"].createElement("div", null, "test-expanded"))),
+        getByRole = _render.getByRole;
+
+    var accordion = getByRole("button");
+    var panel = getByRole("region");
+    expect(accordion.getAttribute("aria-controls")).toBe(panel.id);
+    expect(panel.getAttribute("aria-labelledby")).toBe(accordion.id);
+  });
+  test("Renders expanded by default when it is uncontrolled", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Accordion["default"], {
+      label: "Accordion",
+      defaultIsExpanded: true
+    }, /*#__PURE__*/_react["default"].createElement("div", null, "test-expanded"))),
+        getByRole = _render2.getByRole;
+
+    var accordion = getByRole("button");
+    expect(accordion.getAttribute("aria-expanded")).toBe("true");
+  });
+  test("Calls correct function on click", function () {
+    var onChange = jest.fn();
+
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Accordion["default"], {
+      label: "Accordion",
+      onChange: onChange
+    })),
+        getByText = _render3.getByText;
+
+    _react2.fireEvent.click(getByText("Accordion"));
+
+    expect(onChange).toHaveBeenCalled();
+  });
+  test("Controlled accordion", function () {
+    var onChange = jest.fn();
+
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Accordion["default"], {
+      label: "Accordion",
+      onChange: onChange,
+      isExpanded: true
+    })),
+        getByText = _render4.getByText,
+        getByRole = _render4.getByRole;
+
+    expect(getByRole("button").getAttribute("aria-expanded")).toBe("true");
+
+    _react2.fireEvent.click(getByText("Accordion"));
+
+    _react2.fireEvent.click(getByText("Accordion"));
+
+    _react2.fireEvent.click(getByText("Accordion"));
+
+    expect(onChange).toHaveBeenCalledTimes(3);
+    expect(onChange.mock.calls[0][0]).toBe(false);
+    expect(onChange.mock.calls[1][0]).toBe(false);
+    expect(onChange.mock.calls[2][0]).toBe(false);
+  });
+});

package/accordion/types.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="react" />
+export declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+export declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+export declare type Padding = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+declare type Props = {
+    /**
+     * The panel label.
+     */
+    label: string;
+    /**
+     * Initial state of the panel, only when it is uncontrolled.
+     */
+    defaultIsExpanded?: boolean;
+    /**
+     * Represents the state of the panel. When true, the component will be
+     * expanded. If undefined, the component will be uncontrolled and its
+     * value will be managed internally by the component.
+     */
+    isExpanded?: boolean;
+    /**
+     * Element or path used as the icon that will be placed next to panel label.
+     */
+    icon?: string | SVG;
+    /**
+     * Assistive text to be placed on the right side of the panel.
+     */
+    assistiveText?: string;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * This function will be called when the user clicks the accordion to expand or collapse
+     * the panel. The new state of the panel will be passed as a parameter.
+     */
+    onChange?: (isExpanded: boolean) => void;
+    /**
+     * The expanded panel of the accordion. This area can be used to render
+     * custom content.
+     */
+    children: React.ReactNode;
+    /**
+     * 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;
+    /**
+     * @deprecated This prop will be removed shortly, consider using the Inset component for this purpose.
+     * Size of the padding to be applied to the custom area ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
+     * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different padding sizes.
+     */
+    padding?: Space | Padding;
+    /**
+     * Value of the tabindex.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/accordion/types.js

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

package/accordion-group/AccordionGroup.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import AccordionGroupPropsType, { AccordionPropsType } from "./types";
+declare const DxcAccordionGroup: {
+    ({ defaultIndexActive, indexActive, disabled, onActiveChange, margin, children, }: AccordionGroupPropsType): JSX.Element;
+    Accordion: ({ ...childProps }: AccordionPropsType) => JSX.Element;
+};
+export default DxcAccordionGroup;