@js-empire/emperor-ui 1.0.1 → 1.1.0

package/src/components/organisms/header/header.tsx

@@ -0,0 +1,94 @@
+import { useEmperorUI } from "@hooks";
+import type { HeaderProps, NavBarHoverEffect, NavBarVariant } from "@types";
+import { cn } from "@utils";
+import { VariantProps } from "class-variance-authority";
+import { ComponentProps, forwardRef } from "react";
+import { Brand, NavBar, SideBar } from "@components";
+import { headerClasses, headerStyles } from "./styles";
+import { useDisclosure } from "@heroui/react";
+import { MOCK_HEADER_ITEMS, MOCK_HEADER_ACTIONS } from "@mocks";
+import { SegmentedHeaderContent } from "./segmented-header-content";
+
+export const Header = forwardRef<
+  HTMLElement,
+  ComponentProps<"header"> & VariantProps<typeof headerClasses> & HeaderProps
+>(
+  (
+    { className, variant = "default", glassEffect, children, ...props },
+    ref,
+  ) => {
+    const { config } = useEmperorUI();
+    const { isOpen, onOpenChange } = useDisclosure();
+
+    const primaryColor = config?.theme?.colors?.primary;
+    const foregroundColor = config?.theme?.colors?.foreground;
+
+    const content = children || (
+      <>
+        <SideBar
+          items={MOCK_HEADER_ITEMS}
+          actions={MOCK_HEADER_ACTIONS}
+          isOpen={isOpen}
+          onOpenChange={onOpenChange}
+          header={<Brand className="text-white" />}
+          triggerProps={{
+            startContent: (
+              <Brand
+                className="text-white"
+                classNames={{
+                  logo: "size-6",
+                }}
+              />
+            ),
+            isIconOnly: false,
+            variant: "light",
+          }}
+        />
+
+        <NavBar
+          className="hidden md:flex mx-auto"
+          items={MOCK_HEADER_ITEMS}
+          hoverEffect={
+            {
+              default: "default",
+              floating: "underline",
+              light: "underline",
+              "segmented-floating": "default",
+            }[variant] as NavBarHoverEffect
+          }
+          variant={
+            {
+              default: "default",
+              floating: "default",
+              light: "default",
+              "segmented-floating": "default",
+            }[variant] as NavBarVariant
+          }
+        />
+      </>
+    );
+
+    return (
+      <header
+        ref={ref}
+        data-slot="emperor-header"
+        className={cn(headerClasses({ variant, className }))}
+        style={headerStyles({
+          primaryColor,
+          foregroundColor,
+          variant,
+          glassEffect,
+        })}
+        {...props}
+      >
+        {variant === "segmented-floating" ? (
+          <SegmentedHeaderContent glassEffect={glassEffect}>
+            {content}
+          </SegmentedHeaderContent>
+        ) : (
+          content
+        )}
+      </header>
+    );
+  },
+);

package/src/components/organisms/header/segmented-header-content.tsx

@@ -0,0 +1,37 @@
+import { SegmentedHeaderContentProps } from "@types";
+import { Children } from "react";
+import { Row } from "@components";
+import { useEmperorUI } from "@hooks";
+import { getGlassEffectStyles } from "./styles/styles";
+
+export const SegmentedHeaderContent = ({
+  children,
+  glassEffect,
+}: SegmentedHeaderContentProps) => {
+  const { config } = useEmperorUI();
+
+  const primaryColor = config?.theme?.colors?.primary;
+  const foregroundColor = config?.theme?.colors?.foreground;
+
+  return (
+    <Row className="w-full min-h-12 justify-between">
+      {Children.toArray(children).map((child, index) => (
+        <Row
+          className="rounded-full min-h-12 px-5"
+          key={index}
+          style={{
+            backgroundColor: primaryColor,
+            color: foregroundColor,
+            ...(glassEffect
+              ? getGlassEffectStyles({
+                  glassEffect,
+                })
+              : {}),
+          }}
+        >
+          {child}
+        </Row>
+      ))}
+    </Row>
+  );
+};

package/src/components/organisms/header/stories/header.stories.tsx

@@ -0,0 +1,143 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import { Brand, Header, NavBar } from "@components";
+import { getStorybookDecorators } from "@utils";
+import { FAKE_PARAGRAPH } from "@constants";
+import { MOCK_HEADER_ITEMS } from "@mocks";
+
+const meta: Meta<typeof Header> = {
+  title: "Molecules/Header",
+  component: Header,
+  parameters: {
+    layout: "fullscreen",
+  },
+  tags: ["autodocs"],
+  decorators: getStorybookDecorators({}),
+};
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+const GLASS_EFFECT_CONFIG = {
+  enabled: true,
+  blur: 10,
+  backgroundColor: "#006fed",
+  foregroundColor: "#fff",
+  opacity: 40,
+};
+
+export const Default: Story = {
+  args: {},
+};
+
+export const Floating: Story = {
+  args: {
+    variant: "floating",
+  },
+  render: (args) => {
+    return (
+      <div>
+        <Header {...args} />
+
+        <main className="w-full container mx-auto p-5 pt-24 flex flex-col gap-6">
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+        </main>
+      </div>
+    );
+  },
+};
+
+export const Light: Story = {
+  args: {
+    variant: "light",
+  },
+};
+
+export const WithGlassEffect: Story = {
+  args: {
+    variant: "floating",
+    glassEffect: GLASS_EFFECT_CONFIG,
+  },
+  render: (args) => {
+    return (
+      <div>
+        <Header {...args} />
+
+        <main className="w-full container mx-auto p-5 pt-24 flex flex-col gap-6">
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+        </main>
+      </div>
+    );
+  },
+};
+
+export const SegmentedFloating: Story = {
+  args: {
+    variant: "segmented-floating",
+  },
+  render: (args) => {
+    return (
+      <div>
+        <Header {...args}>
+          <Brand />
+
+          <NavBar
+            items={MOCK_HEADER_ITEMS}
+            hoverEffect="none"
+            variant="default"
+            className="hidden md:flex"
+            subItemsColumns={4}
+          />
+        </Header>
+
+        <main className="w-full container mx-auto p-5 pt-24 flex flex-col gap-6">
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+        </main>
+      </div>
+    );
+  },
+};
+
+export const SegmentedFloatingWithGlassEffect: Story = {
+  args: {
+    variant: "segmented-floating",
+    glassEffect: GLASS_EFFECT_CONFIG,
+  },
+  render: (args) => {
+    return (
+      <div>
+        <Header {...args}>
+          <Brand />
+
+          <NavBar
+            items={MOCK_HEADER_ITEMS}
+            hoverEffect="none"
+            variant="default"
+            className="hidden md:flex"
+            subItemsColumns={4}
+          />
+        </Header>
+
+        <main className="w-full container mx-auto p-5 pt-24 flex flex-col gap-6">
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+          <p>{FAKE_PARAGRAPH}</p>
+        </main>
+      </div>
+    );
+  },
+};

package/src/components/organisms/header/styles/classes.ts

@@ -0,0 +1,22 @@
+import { cva } from "class-variance-authority";
+
+export const headerClasses = cva(
+  ["flex min-h-16 items-center justify-between gap-4 px-6 w-full"],
+  {
+    variants: {
+      variant: {
+        default: ["flex-nowrap w-full"],
+        floating: [
+          "fixed min-h-14 w-[90vw] rounded-full shadow-lg",
+          "top-3 left-1/2 -translate-x-1/2 z-10",
+        ],
+        light: [],
+        "segmented-floating": [
+          "fixed min-h-12 w-[90vw] top-3 left-1/2 -translate-x-1/2 z-10",
+        ],
+      },
+    },
+    defaultVariants: {},
+    compoundVariants: [],
+  },
+);

package/src/components/organisms/header/styles/index.ts

@@ -0,0 +1,2 @@
+export * from "./classes";
+export * from "./styles";

package/src/components/organisms/header/styles/styles.ts

@@ -0,0 +1,39 @@
+import { CSSProperties } from "react";
+import { HeaderGlassEffect, HeaderStylesProps } from "@types";
+
+export const getGlassEffectStyles = ({
+  glassEffect,
+}: {
+  glassEffect: HeaderGlassEffect;
+}): CSSProperties => ({
+  backgroundColor: glassEffect?.backgroundColor
+    ? `${glassEffect?.backgroundColor}${glassEffect?.opacity ?? 30}`
+    : "transparent",
+  backdropFilter: `blur(${glassEffect?.blur ?? 0}px)`,
+  color: glassEffect?.foregroundColor,
+});
+
+export const headerStyles = ({
+  primaryColor,
+  foregroundColor,
+  variant,
+  glassEffect,
+}: HeaderStylesProps): CSSProperties => {
+  if (glassEffect?.enabled && variant !== "segmented-floating") {
+    return getGlassEffectStyles({
+      glassEffect: {
+        ...glassEffect,
+        foregroundColor: glassEffect?.foregroundColor ?? foregroundColor,
+      },
+    });
+  }
+
+  if (["default", "floating"].includes(variant ?? "")) {
+    return {
+      backgroundColor: primaryColor,
+      color: foregroundColor,
+    };
+  }
+
+  return {};
+};

package/src/components/organisms/index.ts

@@ -0,0 +1,4 @@
+export * from "./item-details";
+export * from "./listings";
+export * from "./footer";
+export * from "./header";

package/src/components/templates/index.ts

@@ -0,0 +1 @@
+export * from "./landing-page";

package/src/components/templates/landing-page/index.ts

@@ -0,0 +1 @@
+export * from "./landing-page";

package/src/components/templates/landing-page/landing-page.stories.tsx

@@ -0,0 +1,21 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import { LandingPage } from "@components";
+import { getStorybookDecorators } from "@utils";
+
+const meta: Meta<typeof LandingPage> = {
+  title: "Templates/LandingPage",
+  component: LandingPage,
+  parameters: {
+    layout: "fullscreen",
+  },
+  tags: ["autodocs"],
+  decorators: getStorybookDecorators({}),
+};
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};

package/src/components/templates/landing-page/landing-page.tsx

@@ -0,0 +1,57 @@
+import { forwardRef, ComponentProps } from "react";
+import { VariantProps } from "class-variance-authority";
+import { cn } from "@utils";
+import { LandingPageProps } from "@types";
+import { landingPageClasses } from "./styles";
+import { Brand, Header, NavBar } from "@components";
+import { MOCK_HEADER_ITEMS_WITH_SUB_ITEMS } from "@mocks";
+import { FAKE_PARAGRAPH } from "@constants";
+
+const GLASS_EFFECT_CONFIG = {
+  enabled: true,
+  blur: 10,
+  backgroundColor: "#006fed",
+  foregroundColor: "#fff",
+  opacity: 40,
+};
+
+/**
+ * This component is not for general use nor it is reusable, it is intended to be used as a demo page.
+ */
+export const LandingPage = forwardRef<
+  HTMLDivElement,
+  ComponentProps<"main"> &
+    VariantProps<typeof landingPageClasses> &
+    LandingPageProps
+>(({ className, variant = "default", children, ...props }, ref) => {
+  return (
+    <main
+      ref={ref}
+      data-slot="emperor-landing-page"
+      className={cn(landingPageClasses({ className }))}
+      {...props}
+    >
+      <Header variant="floating" glassEffect={GLASS_EFFECT_CONFIG}>
+        <Brand />
+
+        <NavBar
+          items={MOCK_HEADER_ITEMS_WITH_SUB_ITEMS}
+          hoverEffect="none"
+          variant="default"
+          className="hidden md:flex"
+          subItemsColumns={4}
+        />
+      </Header>
+
+      <main className="w-full container mx-auto p-5 pt-24 flex flex-col gap-6">
+        <p>{FAKE_PARAGRAPH}</p>
+        <p>{FAKE_PARAGRAPH}</p>
+        <p>{FAKE_PARAGRAPH}</p>
+        <p>{FAKE_PARAGRAPH}</p>
+        <p>{FAKE_PARAGRAPH}</p>
+      </main>
+
+      {children}
+    </main>
+  );
+});

package/src/components/templates/landing-page/styles/classes.ts

@@ -0,0 +1,11 @@
+import { cva } from "class-variance-authority";
+
+export const landingPageClasses = cva(["flex flex-col w-full"], {
+  variants: {
+    variant: {
+      default: [],
+    },
+  },
+  defaultVariants: {},
+  compoundVariants: [],
+});

package/src/components/templates/landing-page/styles/index.ts

@@ -0,0 +1 @@
+export * from "./classes";

package/src/constants/defaults.ts

@@ -1,14 +1,14 @@
 import type { ColorsPalette, EmperorUIConfig } from "@types";
 
 export const defaultColorsPalette: ColorsPalette = {
-  primary: "#1E40AF",
-  secondary: "#F59E0B",
-  background: "#FFFFFF",
-  text: "#111827",
-  danger: "#DC2626",
-  warning: "#D97706",
+  primary: "#006FEE",
+  secondary: "#9353d3",
+  background: "#3f3f46",
+  foreground: "#ECEDEE",
+  success: "#17c964",
+  warning: "#f5a524",
+  danger: "#f31260",
   info: "#3B82F6",
-  success: "#16A34A",
 };
 
 export const defaultEmperorUIConfig: EmperorUIConfig = {
@@ -19,4 +19,39 @@ export const defaultEmperorUIConfig: EmperorUIConfig = {
   layout: {
     withScaffold: true,
   },
+  interLocalization: {
+    lang: "en",
+    languages: ["en", "ar"],
+    defaultLanguage: "en",
+    dir: "ltr",
+    isMultiLingual: false,
+    locales: {
+      en: {
+        dropHere: "Drop file here",
+        selectFile: "Select a file or drag and drop here",
+        selectionTypes: "JPG, PNG or PDF, file size no more than 10MB",
+        selectBtn: "Select file",
+        errorUploadingFile: "No file was uploaded",
+        maxNumImages: "Maximum number of uploaded images exceeded: ",
+        errorUploadedTypes: "You can only upload files within these types: ",
+        maxSizeExceededError:
+          "You can only upload files/images with less than MAX_FILE_SIZE Mega Bytes, you're file's size is UPLOADED_FILE_SIZE Mega Bytes",
+        duplicatesDenied:
+          "You can't upload images with duplicate names, you may rename them before the upload process",
+      },
+      ar: {
+        dropHere: "أسقط الملف هنا",
+        selectFile: "حدد ملفًا أو اسحبه وأفلته هنا",
+        selectionTypes: "JPG, PNG أو PDF، حجم الملف لا يزيد عن 10MB",
+        selectBtn: "حدد ملف",
+        errorUploadingFile: "لم يتم تحميل أي ملف",
+        maxNumImages: "تم تجاوز الحد الأقصى للصور المرفوعة: ",
+        errorUploadedTypes: "يمكنك فقط تحميل الملفات من الأنواع التالية: ",
+        maxSizeExceededError:
+          "يمكنك فقط رفع ملفات/صور بحجم أقل من MAX_FILE_SIZE ميغابايت، بينما حجم الملف الذي رفعته هو UPLOADED_FILE_SIZE ميغابايت",
+        duplicatesDenied:
+          "لا يمكنك رفع صور تحمل نفس الاسم، يمكنك إعادة تسميتها قبل عملية الرفع",
+      },
+    },
+  },
 };

package/src/constants/fake.ts

@@ -0,0 +1,2 @@
+export const FAKE_PARAGRAPH =
+  "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc,";

package/src/constants/index.ts

@@ -1 +1,3 @@
 export * from "./defaults";
+export * from "./fake";
+export * from "./uploader";

package/src/constants/uploader.ts

@@ -0,0 +1,27 @@
+export const ALLOWED_IMAGES_TYPES = [
+  "image/jpeg",
+  "image/jpg",
+  "image/png",
+  "image/webp",
+  "image/gif",
+  "image/bmp",
+  "image/svg+xml",
+  "image/tiff",
+  "image/x-icon",
+];
+
+export const ALLOWED_PDF_TYPES = ["application/pdf"];
+
+export const ALLOWED_DOC_TYPES = [
+  "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+];
+
+export const ONE_MEGABYTE = 1024;
+
+export const fileTypesMapping: { [key: string]: string[] } = {
+  image: [".jpg", ".jpeg", ".png"],
+  doc: [".doc", ".docx"],
+  pdf: [".pdf"],
+  video: [".mp4"],
+  sheet: [".xlsx", ".xlx"],
+};

package/src/context/emperor-ui-context.ts

@@ -1,6 +1,6 @@
-import type { EmperorUIContextState } from "@types";
+import type { ConfigContextState } from "@types";
 import { createContext } from "react";
 
-export const EmperorUIContext = createContext<
-  EmperorUIContextState | undefined
->(undefined);
+export const EmperorUIContext = createContext<ConfigContextState | undefined>(
+  undefined,
+);

package/src/context/index.ts

@@ -1 +1,3 @@
 export * from "./emperor-ui-context";
+export * from "./navigation-context";
+export * from "./uploader-context";

package/src/context/navigation-context.ts

@@ -0,0 +1,6 @@
+import type { NavigationContextState } from "@types";
+import { createContext } from "react";
+
+export const NavigationContext = createContext<
+  NavigationContextState | undefined
+>(undefined);

package/src/context/uploader-context.ts

@@ -0,0 +1,6 @@
+import type { UploaderContextState } from "@types";
+import { createContext } from "react";
+
+export const UploaderContext = createContext<UploaderContextState | undefined>(
+  undefined,
+);

package/src/enums/index.ts

@@ -0,0 +1,2 @@
+export * from "./preserved-keys";
+export * from "./placeholders";

package/src/enums/placeholders.ts

@@ -0,0 +1,4 @@
+export enum Placeholders {
+  PLACEHOLDER_MALE_AVATAR = "/images/placeholder-male-avatar.png",
+  PLACEHOLDER_FEMALE_AVATAR = "/images/placeholder-female-avatar.png",
+}

package/src/enums/preserved-keys.ts

@@ -0,0 +1,3 @@
+export enum PreservedKeys {
+  COMPACT_SIDEBAR_ID = "emperor-compact-sidebar",
+}

package/src/hooks/index.ts

@@ -1 +1,4 @@
 export * from "./use-emperor-ui";
+export * from "./use-navigation";
+export * from "./use-uploader-context";
+export * from "./use-uploader";

package/src/hooks/use-navigation.ts

@@ -0,0 +1,12 @@
+import { NavigationContext } from "@context";
+import { useContext } from "react";
+
+export function useNavigation() {
+  const context = useContext(NavigationContext);
+
+  if (!context) {
+    throw new Error("useNavigation must be used within a NavigationProvider");
+  }
+
+  return context;
+}

package/src/hooks/use-uploader-context.ts

@@ -0,0 +1,14 @@
+import { UploaderContext } from "@context";
+import { useContext } from "react";
+
+export function useUploaderContext() {
+  const context = useContext(UploaderContext);
+
+  if (!context) {
+    throw new Error(
+      "useUploaderContext must be used within a UploaderProvider",
+    );
+  }
+
+  return context;
+}