@dxc-technology/halstack-react 0.0.0-5aa300b → 0.0.0-5b32837

package/sidenav/Sidenav.stories.tsx

@@ -1,8 +1,11 @@
 import React from "react";
 import DxcSidenav from "./Sidenav";
+import DxcSelect from "../select/Select";
+import DxcInset from "../inset/Inset";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
 import { userEvent, within } from "@storybook/testing-library";
+import { HalstackProvider } from "../HalstackContext";
 
 export default {
   title: "Sidenav",
@@ -33,6 +36,16 @@ c-10.663,0-17.467,1.853-20.417,5.568c-2.949,3.711-4.428,10.23-4.428,19.558v31.11
   </svg>
 );
 
+const TitleComponent = () => {
+  return <DxcSidenav.Title>Dxc technology</DxcSidenav.Title>;
+};
+
+const opinionatedTheme = {
+  sidenav: {
+    baseColor: "#f2f2f2",
+  },
+};
+
 export const Chromatic = () => (
   <>
     <ExampleContainer>
@@ -101,16 +114,51 @@ export const Chromatic = () => (
         </DxcSidenav.Section>
       </DxcSidenav>
     </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcSidenav title={<TitleComponent />}>
+          <DxcSidenav.Section>
+            <p>
+              Lorem ipsum dolor sit amet, consectetur adipiscing elit. In ullamcorper consectetur mollis. Suspendisse
+              vitae lacinia libero.
+            </p>
+          </DxcSidenav.Section>
+          <DxcSidenav.Section>
+            <DxcSidenav.Link>Single Link</DxcSidenav.Link>
+            <DxcSidenav.Group collapsable={false} title="Single Group" icon={iconSVG}>
+              <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+              <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+              <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+              <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+            </DxcSidenav.Group>
+          </DxcSidenav.Section>
+          <DxcSidenav.Section>
+            <DxcSidenav.Group collapsable={true} title="Section Group" icon={iconSVG}>
+              <DxcSidenav.Link selected>Group Link</DxcSidenav.Link>
+              <DxcSidenav.Link icon={iconSVG}>Group Link</DxcSidenav.Link>
+            </DxcSidenav.Group>
+            <DxcSidenav.Link icon={iconSVG}>Single Link</DxcSidenav.Link>
+            <DxcSidenav.Link>Single Link</DxcSidenav.Link>
+            <DxcSidenav.Group collapsable={false} title="Section Group">
+              <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+              <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+              <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+            </DxcSidenav.Group>
+          </DxcSidenav.Section>
+        </DxcSidenav>
+      </HalstackProvider>
+    </ExampleContainer>
   </>
 );
 
-const CollapsedGroup = () => (
+const CollapsedGroupSidenav = () => (
   <>
     <ExampleContainer>
-      <Title title="Default sidenav" theme="light" level={4} />
+      <Title title="Collapsed group with a selected link" theme="light" level={4} />
       <DxcSidenav title={<DxcSidenav.Title>Dxc technology</DxcSidenav.Title>}>
         <DxcSidenav.Section>
-          <DxcSidenav.Group collapsable={true} title="Collapsable Group" icon={iconSVG}>
+          <DxcSidenav.Group collapsable={true} title="Collapsed Group" icon={iconSVG}>
             <DxcSidenav.Link>Group Link</DxcSidenav.Link>
             <DxcSidenav.Link>Group Link</DxcSidenav.Link>
             <DxcSidenav.Link>Group Link</DxcSidenav.Link>
@@ -118,11 +166,11 @@ const CollapsedGroup = () => (
           </DxcSidenav.Group>
         </DxcSidenav.Section>
         <DxcSidenav.Section>
-          <DxcSidenav.Group collapsable={true} title="Collapsable Group">
-            <DxcSidenav.Link selected>Group Link</DxcSidenav.Link>
+          <DxcSidenav.Group collapsable={true} title="Collapsed Group">
             <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+            <DxcSidenav.Link selected>Group Link</DxcSidenav.Link>
           </DxcSidenav.Group>
-          <DxcSidenav.Group collapsable={false} title="Section Group">
+          <DxcSidenav.Group collapsable={true} title="Section Group">
             <DxcSidenav.Link>Group Link</DxcSidenav.Link>
             <DxcSidenav.Link>Group Link</DxcSidenav.Link>
             <DxcSidenav.Link>Group Link</DxcSidenav.Link>
@@ -133,14 +181,14 @@ const CollapsedGroup = () => (
   </>
 );
 
-const HoverSidenav = () => (
+const HoveredGroupSidenav = () => (
   <ExampleContainer pseudoState="pseudo-hover">
-    <Title title="Default sidenav" theme="light" level={4} />
+    <Title title="Hover state for groups (selected and not)" theme="light" level={4} />
     <DxcSidenav title={<DxcSidenav.Title>Dxc technology</DxcSidenav.Title>}>
       <DxcSidenav.Section>
         <DxcSidenav.Link>Single Link</DxcSidenav.Link>
         <DxcSidenav.Link>Single Link</DxcSidenav.Link>
-        <DxcSidenav.Group collapsable={true} title="Collapsable Group">
+        <DxcSidenav.Group collapsable={true} title="Collapsed Group">
           <DxcSidenav.Link selected>Group Link</DxcSidenav.Link>
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
@@ -154,36 +202,81 @@ const HoverSidenav = () => (
         </DxcSidenav.Group>
         <DxcSidenav.Link>Single Link</DxcSidenav.Link>
         <DxcSidenav.Link>Single Link</DxcSidenav.Link>
-        <DxcSidenav.Group collapsable={true} title="Collapsable Group">
+        <DxcSidenav.Group collapsable={true} title="Collapsed Group">
+          <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+          <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+          <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+        </DxcSidenav.Group>
+        <DxcSidenav.Group collapsable={true} title="Collapsed Group">
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
         </DxcSidenav.Group>
+      </DxcSidenav.Section>
+    </DxcSidenav>
+  </ExampleContainer>
+);
 
-        <DxcSidenav.Group collapsable={true} title="Collapsable Group">
+const ActiveGroupSidenav = () => (
+  <ExampleContainer pseudoState="pseudo-active">
+    <Title title="Active state for groups (selected and not)" theme="light" level={4} />
+    <DxcSidenav title={<DxcSidenav.Title>Dxc technology</DxcSidenav.Title>}>
+      <DxcSidenav.Section>
+        <DxcInset space="1rem">
+          <DxcSelect
+            defaultValue="1"
+            options={[
+              { label: "v1.0.0", value: "1" },
+              { label: "v2.0.0", value: "2" },
+              { label: "v3.0.0", value: "3" },
+              { label: "v4.0.0", value: "4" },
+            ]}
+            size="fillParent"
+          />
+        </DxcInset>
+      </DxcSidenav.Section>
+      <DxcSidenav.Section>
+        <DxcSidenav.Group collapsable={true} title="Collapsed Group">
+          <DxcSidenav.Link selected>Group Link</DxcSidenav.Link>
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
           <DxcSidenav.Link>Group Link</DxcSidenav.Link>
         </DxcSidenav.Group>
       </DxcSidenav.Section>
+      <DxcSidenav.Section>
+        <DxcSidenav.Group collapsable={true} title="Not Collapsed Group">
+          <DxcSidenav.Link selected>Group Link</DxcSidenav.Link>
+          <DxcSidenav.Link>Group Link</DxcSidenav.Link>
+        </DxcSidenav.Group>
+        <DxcSidenav.Link>Single Link</DxcSidenav.Link>
+        <DxcSidenav.Link>Single Link</DxcSidenav.Link>
+      </DxcSidenav.Section>
     </DxcSidenav>
   </ExampleContainer>
 );
 
-export const CollapseGroup = CollapsedGroup.bind({});
-CollapseGroup.play = async ({ canvasElement }) => {
+export const CollapsableGroup = CollapsedGroupSidenav.bind({});
+CollapsableGroup.play = async ({ canvasElement }) => {
   const canvas = within(canvasElement);
-  const collapsableGroups = canvas.getAllByText("Collapsable Group");
+  const collapsableGroups = canvas.getAllByText("Collapsed Group");
   collapsableGroups.forEach((group) => {
     userEvent.click(group);
   });
 };
 
-export const CollapseHoverGroup = HoverSidenav.bind({});
-CollapseHoverGroup.play = async ({ canvasElement }) => {
+export const CollapsedHoverGroup = HoveredGroupSidenav.bind({});
+CollapsedHoverGroup.play = async ({ canvasElement }) => {
   const canvas = within(canvasElement);
-  const collapsableGroups = canvas.getAllByText("Collapsable Group");
+  const collapsableGroups = canvas.getAllByText("Collapsed Group");
   collapsableGroups.forEach((group) => {
     userEvent.click(group);
   });
+  await new Promise((resolve) => setTimeout(resolve, 1000));
 };
+
+export const CollapsedActiveGroup = ActiveGroupSidenav.bind({});
+CollapsedActiveGroup.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const collapsableGroups = canvas.getAllByText("Collapsed Group");
+  userEvent.click(collapsableGroups[0]);
+};

package/sidenav/Sidenav.test.js

@@ -1,20 +1,15 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _react = _interopRequireDefault(require("react"));
-
 var _react2 = require("@testing-library/react");
-
 var _Sidenav = _interopRequireDefault(require("./Sidenav.tsx"));
-
 describe("Sidenav component tests", function () {
   test("Sidenav renders anchors and Section correctly", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Sidenav["default"], null, /*#__PURE__*/_react["default"].createElement(_Sidenav["default"].Section, null, /*#__PURE__*/_react["default"].createElement("p", null, "nav-content-test"), /*#__PURE__*/_react["default"].createElement(_Sidenav["default"].Link, {
-      href: "#"
-    }, "Link")))),
-        getByText = _render.getByText;
-
+        href: "#"
+      }, "Link")))),
+      getByText = _render.getByText;
     expect(getByText("nav-content-test")).toBeTruthy();
     var link = getByText("Link");
     expect(link.closest("a").getAttribute("href")).toBe("#");
@@ -36,9 +31,7 @@ describe("Sidenav component tests", function () {
     }, "Lorem ipsum")))));
     expect(sidenav.getByText("Collapsable")).toBeTruthy();
     expect(sidenav.getAllByRole("button")[0].getAttribute("aria-expanded")).toBe("true");
-
     _react2.fireEvent.click(sidenav.getByText("Collapsable"));
-
     expect(sidenav.getAllByRole("button")[0].getAttribute("aria-expanded")).toBe("false");
   });
 });

package/sidenav/types.d.ts

@@ -1,50 +1,37 @@
 /// <reference types="react" />
-declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
-declare type SidenavPropsType = {
-    /**
-     * The area inside the sidenav. This area can be used to render the content inside the sidenav.
-     */
-    children: React.ReactNode;
-    /**
-     * The area assigned to render the sidenav title. It is highly recommended to use the sidenav title.
-     */
-    title?: React.ReactNode;
-};
-export declare type SidenavTitlePropsType = {
+type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+export type SidenavTitlePropsType = {
     /**
      * The area inside the sidenav title. This area can be used to render custom content.
      */
     children: React.ReactNode;
 };
-export declare type SidenavSectionPropsType = {
+export type SidenavSectionPropsType = {
     /**
      * The area inside the sidenav section. This area can be used to render sidenav groups, links and custom content.
      */
     children: React.ReactNode;
 };
-export declare type SidenavGroupPropsType = {
-    /**
-     * The area inside the sidenav group. This area can be used to render sidenav links.
-     */
-    children: React.ReactNode;
+export type SidenavGroupPropsType = {
     /**
      * The title of the sidenav group.
      */
     title?: string;
     /**
-     * If true the sidenav group title will be considered a button and the group will be collapsable.
+     * If true, the sidenav group will be a button that will allow you to collapse the links contained within it.
+     * In addition, if it's collapsed and contains the currently selected link, the group title will also be marked as selected.
      */
     collapsable?: boolean;
     /**
      * The icon to be displayed next to the title of the group.
      */
     icon?: string | SVG;
-};
-export declare type SidenavLinkPropsType = {
     /**
-     * Value of the tabindex.
+     * The area inside the sidenav group. This area can be used to render sidenav links.
      */
-    tabIndex?: number;
+    children: React.ReactNode;
+};
+export type SidenavLinkPropsType = {
     /**
      * Page to be opened when the user clicks on the link.
      */
@@ -58,16 +45,32 @@ export declare type SidenavLinkPropsType = {
      */
     icon?: string | SVG;
     /**
-     * If true, the link will be marked as selected. This can also affect the group if it is closed to indicate that one of its links is selected.
+     * If true, the link will be marked as selected. Moreover, in that same case,
+     * if it is contained within a collapsed group, and consequently, the currently selected link is not visible,
+     * the group title will appear as selected too.
      */
     selected?: boolean;
+    /**
+     * This function will be called when the user clicks the link and the event will be passed to this function.
+     */
+    onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
     /**
      * The area inside the sidenav link.
      */
-    children: string;
+    children: React.ReactNode;
+    /**
+     * Value of the tabindex.
+     */
+    tabIndex?: number;
+};
+type Props = {
+    /**
+     * The area assigned to render the sidenav title. It is highly recommended to use the sidenav title.
+     */
+    title?: React.ReactNode;
     /**
-     * This function will be called when the user clicks the link.
+     * The area inside the sidenav. This area can be used to render the content inside the sidenav.
      */
-    onClick?: ($event: any) => void;
+    children: React.ReactNode;
 };
-export default SidenavPropsType;
+export default Props;