@yourdash/uikit 1.0.1 → 1.0.3

package/views/carousel/carousel.module.scss

@@ -0,0 +1,77 @@
+@use "@yourdash/uikit/theme/themeValues" as *;
+
+.containerComponent {
+  display: flex;
+  flex-direction: row;
+  max-width: 100%;
+  height: 24rem;
+  position: relative;
+  padding: 0;
+  overflow: hidden;
+}
+
+.component {
+  display: flex;
+  align-items: center;
+  max-width: 100%;
+  height: 24rem;
+  gap: 0.5rem;
+  padding: var(#{$theme+$padding});
+  flex-direction: row;
+  overflow-x: auto;
+  scroll-snap-type: x mandatory;
+  scroll-snap-stop: always;
+  scrollbar-width: none;
+  padding-bottom: 2.5rem;
+
+  &::-webkit-scrollbar {
+    display: none;
+  }
+}
+
+.page {
+  display: flex;
+  width: 80%;
+  height: 100%;
+  flex-shrink: 0;
+  scroll-snap-align: center;
+
+  &:first-of-type {
+    margin-left: calc(20% + var(#{$theme+$gap}));
+  }
+
+  &:last-of-type {
+    margin-right: calc(20% + var(#{$theme+$gap}));
+  }
+}
+
+.controls {
+  position: absolute;
+  bottom: 0;
+  left: 50%;
+  transform: translateX(-50%);
+  display: flex;
+  flex-direction: row;
+  gap: var(#{$theme+$gap});
+}
+
+.indicator {
+  display: flex;
+  flex-direction: row;
+  gap: var(#{$theme+$gap});
+  padding: calc(var(#{$theme+$padding}) / 2);
+  border-radius: var(#{$theme+$radius});
+
+  .pageIndicator {
+    background-color: var(#{$theme+$color});
+    padding: 0.5rem;
+    border-radius: var(#{$theme+$radius});
+    transition: var(#{$theme+$transition});
+    position: relative;
+
+    &.selected {
+      padding-right: 1.5rem;
+      padding-left: 1.5rem;
+    }
+  }
+}

package/views/carousel/carousel.tsx

@@ -0,0 +1,138 @@
+import page from "@yourdash/web/src/deprecatedLogin/Page.tsx";
+import React, { useEffect, useRef, useState } from "react";
+import Card from "../../components/card/card.tsx";
+import Container from "../../components/container/container.tsx";
+import { UKIcon } from "../../components/icon/iconDictionary.ts";
+import IconButton from "../../components/iconButton/iconButton.tsx";
+import styles from "./carousel.module.scss";
+import clippy from "@yourdash/shared/web/helpers/clippy.ts";
+
+const Carousel: React.FC<{
+  items: { element: React.ReactElement; id: string }[];
+  className?: string;
+}> = ({ items, className }) => {
+  const scrollRef = useRef<HTMLDivElement>(null);
+  const [currentPage, setCurrentPage] = useState<number>(0);
+
+  useEffect(() => {
+    const scrollElement = scrollRef.current;
+
+    if (!scrollElement) return;
+
+    console.log(Array.from(scrollElement.children));
+
+    let timer: Timer;
+    let listener = () => {
+      clearTimeout(timer);
+      timer = setTimeout(function () {
+        Array.from(scrollElement.children).forEach((ele: Element, index: number) => {
+          if (
+            Math.abs(
+              ele.getBoundingClientRect().left +
+                ele.getBoundingClientRect().width / 2 -
+                (scrollElement.getBoundingClientRect().left + scrollElement.getBoundingClientRect().width / 2),
+            ) <
+            ele.getBoundingClientRect().width / 2
+          ) {
+            setCurrentPage(index);
+            return;
+          }
+        });
+      }, 25);
+    };
+
+    scrollElement.addEventListener("scroll", listener);
+
+    return () => {
+      scrollElement.removeEventListener("scroll", listener);
+      clearTimeout(timer);
+    };
+  }, []);
+
+  return (
+    <Container className={clippy(styles.containerComponent, className)}>
+      <div
+        className={styles.component}
+        ref={scrollRef}
+      >
+        {items.map((child) => {
+          return (
+            <div
+              key={child.id}
+              className={styles.page}
+            >
+              {child.element}
+            </div>
+          );
+        })}
+      </div>
+      <div className={styles.controls}>
+        <IconButton
+          accessibleLabel={"previous page"}
+          icon={UKIcon.ChevronLeft}
+          className={styles.pageControl}
+          onClick={() => {
+            const scrollElement = scrollRef.current;
+
+            if (!scrollElement) {
+              return;
+            }
+
+            const carouselTargetPage = scrollElement.children[currentPage - 1] as HTMLDivElement;
+
+            if (!carouselTargetPage) {
+              return;
+            }
+
+            carouselTargetPage.scrollIntoView({ behavior: "smooth" });
+          }}
+        />
+        <Card className={styles.indicator}>
+          {items.map((page, index) => {
+            return (
+              <button
+                key={page.id}
+                className={clippy(styles.pageIndicator, index === currentPage && styles.selected)}
+                onClick={() => {
+                  const scrollElement = scrollRef.current;
+
+                  if (!scrollElement) {
+                    return;
+                  }
+
+                  scrollElement.scrollIntoView({ behavior: "smooth" });
+
+                  const carouselTargetPage = scrollElement.children[index] as HTMLDivElement;
+
+                  carouselTargetPage.scrollIntoView({ behavior: "smooth" });
+                }}
+              />
+            );
+          })}
+        </Card>
+        <IconButton
+          accessibleLabel={"next page"}
+          icon={UKIcon.ChevronRight}
+          className={styles.pageControl}
+          onClick={() => {
+            const scrollElement = scrollRef.current;
+
+            if (!scrollElement) {
+              return;
+            }
+
+            const carouselTargetPage = scrollElement.children[currentPage + 1] as HTMLDivElement;
+
+            if (!carouselTargetPage) {
+              return;
+            }
+
+            carouselTargetPage.scrollIntoView({ behavior: "smooth" });
+          }}
+        />
+      </div>
+    </Container>
+  );
+};
+
+export default Carousel;

package/views/header/header.module.scss

@@ -0,0 +1,16 @@
+/*!
+ * Copyright ©2024 Ewsgit <https://ewsgit.uk> and YourDash <https://yourdash.ewsgit.uk> contributors.
+ * YourDash is licensed under the MIT License. (https://mit.ewsgit.uk)
+ */
+
+@use "@yourdash/uikit/theme/themeValues" as *;
+
+.view {
+  width: 100%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  padding: var(#{$theme+$padding});
+  padding-top: calc(var(#{$theme+$padding}) * 4);
+  padding-bottom: calc(var(#{$theme+$padding}) * 4);
+}

package/views/header/header.tsx

@@ -0,0 +1,28 @@
+/*
+ * Copyright ©2024 Ewsgit <https://ewsgit.uk> and YourDash <https://yourdash.ewsgit.uk> contributors.
+ * YourDash is licensed under the MIT License. (https://mit.ewsgit.uk)
+ */
+
+import React from "react";
+import Heading from "../../components/heading/heading.tsx";
+import styles from "./header.module.scss";
+
+const Header: React.FC<{ backgroundImage?: string; heading: string }> = ({ backgroundImage, heading }) => {
+  return (
+    <>
+      <div
+        className={styles.view}
+        style={
+          backgroundImage ? { backgroundImage: backgroundImage } : { backgroundImage: "linear-gradient(-45deg, #ff8093aa, #ffd264aa)" }
+        }
+      >
+        <Heading
+          level={1}
+          text={heading}
+        />
+      </div>
+    </>
+  );
+};
+
+export default Header;

package/views/infiniteScroll/infiniteScroll.module.scss

@@ -0,0 +1,26 @@
+/*!
+ * Copyright ©2024 Ewsgit<https://ewsgit.uk> and YourDash<https://yourdash.ewsgit.uk> contributors.
+ * YourDash is licensed under the MIT License. (https://mit.ewsgit.uk)
+ */
+
+@use "@yourdash/uikit/theme/themeValues" as *;
+
+.component {
+  display: flex;
+  flex-direction: column;
+  width: 100%;
+  height: 100%;
+  gap: 1rem;
+  align-items: center;
+}
+
+.items {
+  height: 100%;
+}
+
+.endOfItems {
+  text-align: center;
+  padding: var(#{$theme+$padding});
+  gap: var(#{$theme+$gap});
+  width: calc(100% - calc(var(#{$theme+$padding}) * 2));
+}

package/views/infiniteScroll/infiniteScroll.tsx

@@ -0,0 +1,90 @@
+/*
+ *    Copyright ©2024 Ewsgit<https://ewsgit.uk> and YourDash<https://yourdash.ewsgit.uk> contributors.
+ *    YourDash is licensed under the MIT License. (https://mit.ewsgit.uk)
+ */
+
+import clippy from "@yourdash/shared/web/helpers/clippy.ts";
+import React, { useEffect, useState } from "react";
+import Heading from "../../components/heading/heading.tsx";
+import Separator from "../../components/separator/separator.tsx";
+import Text from "../../components/text/text.tsx";
+import styles from "./infiniteScroll.module.scss";
+
+const InfiniteScroll: React.FC<{
+  children: React.ReactNode | React.ReactNode[];
+  fetchNextPage: (nextPageNumber: number) => Promise<{ hasAnotherPage?: boolean }>;
+  containerClassName?: string;
+  className?: string;
+  resetState?: string;
+}> = ({ children, fetchNextPage, containerClassName, className, resetState }) => {
+  const endOfItemsRef = React.useRef<HTMLDivElement>(null);
+  const lastFetchedPage = React.useRef<number>(-1);
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+  const [isLastPage, setIsLastPage] = useState<boolean>(false);
+
+  useEffect(() => {
+    lastFetchedPage.current = -1;
+    setIsLoading(false);
+    setIsLastPage(false);
+    fetchNextPageWrapper();
+  }, [resetState]);
+
+  async function fetchNextPageWrapper() {
+    if (isLoading) return;
+    setIsLoading(true);
+    const { hasAnotherPage } = await fetchNextPage(lastFetchedPage.current + 1);
+    lastFetchedPage.current++;
+    setIsLoading(false);
+    setIsLastPage(hasAnotherPage || false);
+  }
+
+  useEffect(() => {
+    if (!endOfItemsRef.current) return;
+
+    const element: HTMLDivElement = endOfItemsRef.current;
+
+    const observer = new IntersectionObserver((elem) => {
+      console.log("observer update");
+      const isVisible = elem[0].isIntersecting;
+
+      if (isVisible) fetchNextPageWrapper();
+    });
+
+    observer.observe(element);
+  }, []);
+
+  // TODO: Use interaction observer to detect when the last item is shown on the screen and fetch the next page
+
+  return (
+    <div className={clippy(containerClassName, styles.component)}>
+      {/* @ts-ignore */}
+      {children?.length > 0 ? (
+        <div className={clippy(className, styles.items)}>{children}</div>
+      ) : (
+        <div className={"text-center"}>
+          <Heading
+            level={1}
+            text={"Whoops."}
+          />
+          <Separator direction={"column"} />
+          <Text text={"It looks like nothing could be found..."} />
+        </div>
+      )}
+      <div
+        ref={endOfItemsRef}
+        className={styles.endOfItems}
+      >
+        {isLoading && <Text text={"Loading more content"} />}
+        <Separator direction={"column"} />
+        {isLastPage && (
+          <Text
+            text={"No more items to load"}
+            className={styles.endOfItems}
+          />
+        )}
+      </div>
+    </div>
+  );
+};
+
+export default InfiniteScroll;

package/views/navBar/components/navImage/navImage.module.scss

@@ -0,0 +1,7 @@
+@use "@yourdash/uikit/theme/themeValues" as *;
+
+.component {
+    height: calc(var(--nav-height) - var(#{$theme+$padding}));
+    aspect-ratio: 1 / 1;
+    border-radius: 0;
+}

package/views/navBar/components/navImage/navImage.tsx

@@ -0,0 +1,15 @@
+import React from "react";
+import Image from "../../../../components/image/image.tsx";
+import styles from "./navImage.module.scss";
+
+const NavImage: React.FC<{ src: string }> = ({ src }) => {
+  return (
+    <Image
+      accessibleLabel=""
+      src={src}
+      className={styles.component}
+    />
+  );
+};
+
+export default NavImage;

package/views/navBar/components/navTitle/navTitle.tsx

@@ -0,0 +1,13 @@
+import React from "react";
+import Heading from "../../../../components/heading/heading.tsx";
+
+const NavTitle: React.FC<{ title: string }> = ({ title }) => {
+  return (
+    <Heading
+      text={title}
+      level={2}
+    />
+  );
+};
+
+export default NavTitle;

package/views/navBar/navBar.module.scss

@@ -0,0 +1,22 @@
+@use "@yourdash/uikit/theme/themeValues" as *;
+
+.component {
+    --nav-height: calc(2rem + var(#{$theme+$padding}));
+
+    width: 100%;
+    height: calc(var(--nav-height) + calc(var(#{$theme+$padding}) * 2));
+    border-top: 0;
+    border-left: 0;
+    border-right: 0;
+    padding: var(#{$theme+$padding});
+    display: grid;
+    grid-template-columns: auto 1fr auto;
+    justify-content: center;
+    align-items: center;
+}
+
+.segment {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}

package/views/navBar/navBar.tsx

@@ -0,0 +1,37 @@
+import React from "react";
+import Box from "../../components/box/box.tsx";
+import styles from "./navBar.module.scss";
+import Flex from "../../components/flex/flex.tsx";
+import clippy from "@yourdash/shared/web/helpers/clippy.ts";
+
+const NavBar: React.FC<{
+  leftSection?: React.ReactElement | React.ReactElement[];
+  centerSection?: React.ReactElement | React.ReactElement[];
+  rightSection?: React.ReactElement | React.ReactElement[];
+  className?: string;
+}> = ({ leftSection, centerSection, rightSection, className }) => {
+  return (
+    <Box className={clippy(styles.component, className)}>
+      <Flex
+        className={styles.segment}
+        direction="row"
+      >
+        {leftSection}
+      </Flex>
+      <Flex
+        className={styles.segment}
+        direction="row"
+      >
+        {centerSection}
+      </Flex>
+      <Flex
+        className={styles.segment}
+        direction="row"
+      >
+        {rightSection}
+      </Flex>
+    </Box>
+  );
+};
+
+export default NavBar;

package/views/onBoarding/onBoarding.module.scss

@@ -0,0 +1,84 @@
+@use "@yourdash/uikit/theme/themeValues" as *;
+
+.page {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-direction: column;
+  width: 100%;
+  height: 100%;
+  position: relative;
+  animation: fadeIn 1s 0s cubic-bezier(0.215, 0.610, 0.355, 1);
+
+  &::before {
+    content: "";
+    //noinspection CssUnknownTarget
+    background-image: url("/assets/productLogos/yourdash.svg");
+    background-size: 20rem;
+    background-repeat: repeat;
+    width: 1000rem;
+    height: 1000rem;
+    position: absolute;
+    filter: blur(0.25rem) grayscale(1);
+    opacity: 0.1;
+    transform: rotate(-45deg);
+    z-index: -1;
+  }
+
+  @keyframes fadeIn {
+    from {
+      transform: translateY(2.5rem);
+      opacity: 0;
+    }
+    to {
+      transform: translateY(0);
+      opacity: 1;
+    }
+  }
+}
+
+.card {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-direction: column;
+  gap: calc(var(#{$theme+$gap}) * 2);
+  padding: 2rem;
+  position: relative;
+  transition: var(--transition);
+}
+
+.cardContainer {
+  box-shadow: #00000088 0 0 4rem;
+}
+
+.goBackButton {
+  position: absolute;
+  top: var(#{$theme+$padding});
+  left: var(#{$theme+$padding});
+}
+
+.headerImage {
+  height: 16rem;
+}
+
+.header {
+  line-height: 1;
+  text-align: center;
+}
+
+.body {
+  text-align: center;
+}
+
+.actions {
+}
+
+.action {
+}
+
+.actionWithoutIcon {
+}
+
+.actionWithIcon {
+}

package/views/onBoarding/onBoarding.tsx

@@ -0,0 +1,138 @@
+import * as React from "react";
+import Card from "../../components/card/card.tsx";
+import { UKIcon } from "../../components/icon/iconDictionary.ts";
+import IconButton from "../../components/iconButton/iconButton.tsx";
+import Image from "../../components/image/image.tsx";
+import Heading from "../../components/heading/heading.tsx";
+import Text from "../../components/text/text.tsx";
+import ButtonWithIcon from "../../components/buttonWithIcon/buttonWithIcon.tsx";
+import Button from "../../components/button/button.tsx";
+import { Outlet } from "react-router";
+import styles from "./onBoarding.module.scss";
+import Flex from "../../components/flex/flex.tsx";
+import clippy from "@yourdash/shared/web/helpers/clippy.ts";
+
+const OnBoarding: React.FC<{
+  meta: { id: string };
+  pages: {
+    headerImage: string;
+    header: string;
+    body: string;
+    actions: { label: string; icon?: UKIcon; onClick: () => void; changeTo?: "next" | "previous" | "remain" | "completed" }[];
+    allowGoBack?: boolean;
+  }[];
+}> = ({ pages, meta }) => {
+  const [currentPage, setCurrentPage] = React.useState<number>(0);
+  const page = pages[currentPage];
+
+  if (localStorage.getItem(`yourdash-application-visited-${meta.id}`) || currentPage > pages.length - 1) {
+    localStorage.setItem(`yourdash-application-visited-${meta.id}`, "true");
+
+    return <Outlet />;
+  }
+
+  return (
+    <div className={styles.page}>
+      <Card
+        className={styles.card}
+        containerClassName={styles.cardContainer}
+      >
+        {page.allowGoBack && (
+          <IconButton
+            className={clippy(styles.goBackButton, "animate__animated animate__fadeInDown")}
+            accessibleLabel="Go back to the last page"
+            icon={UKIcon.ChevronLeft}
+            onClick={() => {
+              setCurrentPage(currentPage - 1);
+            }}
+          />
+        )}
+        <Image
+          className={styles.headerImage}
+          src={page.headerImage}
+          accessibleLabel=""
+        />
+        <Heading
+          className={styles.header}
+          text={page.header}
+        />
+        <Text
+          className={styles.body}
+          text={page.body}
+        />
+        <Flex
+          className={styles.actions}
+          direction="row"
+        >
+          {page.actions.map((action) => {
+            if (action.icon) {
+              return (
+                <>
+                  <ButtonWithIcon
+                    key={action.label}
+                    className={clippy(styles.action, styles.actionWithIcon, "animate__animated animate__fadeInUp")}
+                    text={action.label}
+                    icon={action.icon}
+                    onClick={() => {
+                      action.onClick();
+                      if (action.changeTo) {
+                        switch (action.changeTo) {
+                          case "next":
+                            setCurrentPage(currentPage + 1);
+                            break;
+                          case "previous":
+                            if (currentPage > 0) setCurrentPage(currentPage - 1);
+                            break;
+                          case "remain":
+                            break;
+                          case "completed":
+                            setCurrentPage(pages.length + 1);
+                            break;
+                          default:
+                            break;
+                        }
+                      }
+                    }}
+                  />
+                </>
+              );
+            }
+
+            return (
+              <>
+                <Button
+                  key={action.icon}
+                  className={clippy(styles.action, styles.actionWithoutIcon, "animate__animated animate__fadeInUp")}
+                  text={action.label}
+                  onClick={() => {
+                    action.onClick();
+
+                    if (action.changeTo) {
+                      switch (action.changeTo) {
+                        case "next":
+                          setCurrentPage(currentPage + 1);
+                          break;
+                        case "previous":
+                          if (currentPage > 0) setCurrentPage(currentPage - 1);
+                          break;
+                        case "remain":
+                          break;
+                        case "completed":
+                          setCurrentPage(pages.length + 1);
+                          break;
+                        default:
+                          break;
+                      }
+                    }
+                  }}
+                />
+              </>
+            );
+          })}
+        </Flex>
+      </Card>
+    </div>
+  );
+};
+
+export default OnBoarding;