@refraktor/core 0.0.2 → 0.0.4

package/src/components/drawer/drawer.test.tsx

@@ -0,0 +1,274 @@
+import { describe, expect, it, vi } from "vitest";
+import { render, screen, userEvent, waitFor } from "../../vitest";
+import Drawer from "./drawer";
+import { DrawerBody } from "./drawer-body";
+import { DrawerContent } from "./drawer-content";
+import { DrawerOverlay } from "./drawer-overlay";
+import { DrawerRoot } from "./drawer-root";
+
+describe("@refraktor/core/Drawer", () => {
+    const transitionProps = {
+        duration: 0,
+        immediate: true
+    } as const;
+
+    it("renders with compound subcomponents and closes with header close button", async () => {
+        const user = userEvent.setup();
+
+        await render(
+            <Drawer.Root defaultOpened transitionProps={transitionProps}>
+                <Drawer.Overlay />
+
+                <Drawer.Content>
+                    <Drawer.Header text="Edit profile" />
+                    <Drawer.Body>
+                        <p>Drawer body</p>
+                    </Drawer.Body>
+                </Drawer.Content>
+            </Drawer.Root>
+        );
+
+        expect(
+            await screen.findByRole("dialog", { name: "Edit profile" })
+        ).toBeInTheDocument();
+
+        await user.click(screen.getByRole("button", { name: "Close" }));
+
+        await waitFor(() => {
+            expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
+        });
+    });
+
+    it("calls onOpenedChange when clicking overlay in controlled mode", async () => {
+        const user = userEvent.setup();
+        const onOpenedChange = vi.fn();
+
+        await render(
+            <Drawer.Root
+                opened
+                onOpenedChange={onOpenedChange}
+                transitionProps={transitionProps}
+            >
+                <Drawer.Overlay data-testid="overlay" />
+                <Drawer.Content>Controlled drawer</Drawer.Content>
+            </Drawer.Root>
+        );
+
+        await user.click(await screen.findByTestId("overlay"));
+
+        expect(onOpenedChange).toHaveBeenCalledWith(false);
+    });
+
+    it("closes on Escape key", async () => {
+        const user = userEvent.setup();
+
+        await render(
+            <Drawer.Root defaultOpened transitionProps={transitionProps}>
+                <Drawer.Content>Keyboard close</Drawer.Content>
+            </Drawer.Root>
+        );
+
+        await screen.findByRole("dialog");
+
+        await user.keyboard("{Escape}");
+
+        await waitFor(() => {
+            expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
+        });
+    });
+
+    it("supports standalone subcomponents with DrawerRoot", async () => {
+        await render(
+            <DrawerRoot defaultOpened transitionProps={transitionProps}>
+                <DrawerOverlay />
+                <DrawerContent>Standalone composition</DrawerContent>
+            </DrawerRoot>
+        );
+
+        expect(await screen.findByRole("dialog")).toBeInTheDocument();
+    });
+
+    it("applies custom overlay background opacity and blur", async () => {
+        await render(
+            <Drawer.Root defaultOpened transitionProps={transitionProps}>
+                <Drawer.Overlay
+                    data-testid="overlay"
+                    backgroundOpacity={0.4}
+                    blur={6}
+                />
+                <Drawer.Content>Styled overlay</Drawer.Content>
+            </Drawer.Root>
+        );
+
+        const overlay = await screen.findByTestId("overlay");
+
+        expect(overlay).toHaveStyle({
+            backgroundColor: "rgba(0, 0, 0, 0.4)",
+            backdropFilter: "blur(6px)"
+        });
+    });
+
+    it("supports different positions and predefined sizes", async () => {
+        await render(
+            <>
+                <Drawer.Root
+                    defaultOpened
+                    position="left"
+                    size="sm"
+                    transitionProps={transitionProps}
+                >
+                    <Drawer.Content data-testid="left-content">
+                        Left
+                    </Drawer.Content>
+                </Drawer.Root>
+
+                <Drawer.Root
+                    defaultOpened
+                    position="bottom"
+                    size="xl"
+                    transitionProps={transitionProps}
+                >
+                    <Drawer.Content data-testid="bottom-content">
+                        Bottom
+                    </Drawer.Content>
+                </Drawer.Root>
+            </>
+        );
+
+        const leftContent = await screen.findByTestId("left-content");
+        const bottomContent = await screen.findByTestId("bottom-content");
+
+        expect(leftContent).toHaveAttribute("data-position", "left");
+        expect(leftContent).toHaveStyle({ width: "20rem" });
+        expect(bottomContent).toHaveAttribute("data-position", "bottom");
+        expect(bottomContent).toHaveStyle({ height: "36rem" });
+    });
+
+    it("renders Drawer.Body subcomponent", async () => {
+        await render(
+            <Drawer.Root defaultOpened transitionProps={transitionProps}>
+                <Drawer.Content>
+                    <Drawer.Body data-testid="body">Body content</Drawer.Body>
+                </Drawer.Content>
+            </Drawer.Root>
+        );
+
+        const body = await screen.findByTestId("body");
+        expect(body).toBeInTheDocument();
+        expect(body).toHaveTextContent("Body content");
+    });
+
+    it("renders standalone DrawerBody component", async () => {
+        await render(
+            <DrawerRoot defaultOpened transitionProps={transitionProps}>
+                <DrawerContent>
+                    <DrawerBody data-testid="body">Standalone body</DrawerBody>
+                </DrawerContent>
+            </DrawerRoot>
+        );
+
+        expect(await screen.findByTestId("body")).toHaveTextContent(
+            "Standalone body"
+        );
+    });
+
+    describe("single-component shorthand API", () => {
+        it("renders with title, overlay, close button, and body", async () => {
+            await render(
+                <Drawer
+                    defaultOpened
+                    title="Edit profile"
+                    transitionProps={transitionProps}
+                >
+                    <p>Profile form</p>
+                </Drawer>
+            );
+
+            expect(
+                await screen.findByRole("dialog", { name: "Edit profile" })
+            ).toBeInTheDocument();
+            expect(screen.getByText("Profile form")).toBeInTheDocument();
+            expect(
+                screen.getByRole("button", { name: "Close" })
+            ).toBeInTheDocument();
+        });
+
+        it("hides overlay when withOverlay is false", async () => {
+            const { container } = await render(
+                <Drawer
+                    defaultOpened
+                    title="No overlay"
+                    withOverlay={false}
+                    transitionProps={transitionProps}
+                />
+            );
+
+            expect(await screen.findByRole("dialog")).toBeInTheDocument();
+            expect(
+                container.ownerDocument.querySelector("[aria-hidden='true']")
+            ).toBeNull();
+        });
+
+        it("hides close button when withCloseButton is false", async () => {
+            await render(
+                <Drawer
+                    defaultOpened
+                    title="No close"
+                    withCloseButton={false}
+                    transitionProps={transitionProps}
+                />
+            );
+
+            await screen.findByRole("dialog");
+            expect(
+                screen.queryByRole("button", { name: "Close" })
+            ).not.toBeInTheDocument();
+        });
+
+        it("closes via shorthand close button", async () => {
+            const user = userEvent.setup();
+
+            await render(
+                <Drawer
+                    defaultOpened
+                    title="Closeable"
+                    transitionProps={transitionProps}
+                >
+                    Content
+                </Drawer>
+            );
+
+            await screen.findByRole("dialog");
+
+            await user.click(screen.getByRole("button", { name: "Close" }));
+
+            await waitFor(() => {
+                expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
+            });
+        });
+
+        it("passes overlayProps to the overlay", async () => {
+            await render(
+                <Drawer
+                    defaultOpened
+                    title="Custom overlay"
+                    overlayProps={{
+                        backgroundOpacity: 0.8,
+                        blur: 10,
+                        "data-testid": "shorthand-overlay"
+                    } as any}
+                    transitionProps={transitionProps}
+                >
+                    Content
+                </Drawer>
+            );
+
+            const overlay = await screen.findByTestId("shorthand-overlay");
+
+            expect(overlay).toHaveStyle({
+                backgroundColor: "rgba(0, 0, 0, 0.8)",
+                backdropFilter: "blur(10px)"
+            });
+        });
+    });
+});

package/src/components/drawer/drawer.tsx

@@ -0,0 +1,58 @@
+import {
+    createClassNamesConfig,
+    createComponentConfig,
+    factory
+} from "../../utils";
+import { DrawerBody } from "./drawer-body";
+import { DrawerClose } from "./drawer-close";
+import { DrawerContent } from "./drawer-content";
+import { DrawerHeader } from "./drawer-header";
+import { DrawerOverlay } from "./drawer-overlay";
+import { DrawerRoot } from "./drawer-root";
+import {
+    DrawerClassNames,
+    DrawerFactoryPayload,
+    DrawerProps
+} from "./drawer.types";
+
+const Drawer = factory<DrawerFactoryPayload>(
+    (
+        {
+            title,
+            withOverlay = true,
+            withCloseButton = true,
+            overlayProps,
+            children,
+            ...rootProps
+        },
+        ref
+    ) => {
+        return (
+            <DrawerRoot {...rootProps} ref={ref}>
+                {withOverlay && <DrawerOverlay {...overlayProps} />}
+
+                <DrawerContent>
+                    {(title || withCloseButton) && (
+                        <DrawerHeader withClose={withCloseButton}>
+                            {title}
+                        </DrawerHeader>
+                    )}
+
+                    <DrawerBody>{children}</DrawerBody>
+                </DrawerContent>
+            </DrawerRoot>
+        );
+    }
+);
+
+Drawer.displayName = "@refraktor/core/Drawer";
+Drawer.configure = createComponentConfig<DrawerProps>();
+Drawer.classNames = createClassNamesConfig<DrawerClassNames>();
+Drawer.Root = DrawerRoot;
+Drawer.Overlay = DrawerOverlay;
+Drawer.Content = DrawerContent;
+Drawer.Header = DrawerHeader;
+Drawer.Body = DrawerBody;
+Drawer.Close = DrawerClose;
+
+export default Drawer;

package/src/components/drawer/drawer.types.ts

@@ -0,0 +1,192 @@
+import { ComponentPropsWithoutRef, MouseEvent, ReactNode } from "react";
+import {
+    createClassNamesConfig,
+    createComponentConfig,
+    FactoryPayload
+} from "../../utils";
+import { RefraktorRadius, RefraktorSize } from "../../theme";
+import { TransitionProps } from "../transition";
+import { DrawerRoot } from "./drawer-root";
+import { DrawerOverlay } from "./drawer-overlay";
+import { DrawerContent } from "./drawer-content";
+import { DrawerHeader } from "./drawer-header";
+import { DrawerBody } from "./drawer-body";
+import { DrawerClose } from "./drawer-close";
+
+export type DrawerPosition = "left" | "right" | "top" | "bottom";
+
+export type DrawerClassNames = {
+    root?: string;
+    overlay?: string;
+    content?: string;
+    header?: string;
+    body?: string;
+    close?: string;
+};
+
+export interface DrawerRootProps extends ComponentPropsWithoutRef<"div"> {
+    /** Children containing drawer subcomponents */
+    children?: ReactNode;
+
+    /** State of the drawer (controlled) */
+    opened?: boolean;
+
+    /** Initial state of the drawer (uncontrolled) */
+    defaultOpened?: boolean;
+
+    /** Callback called when drawer state changes */
+    onOpenedChange?: (opened: boolean) => void;
+
+    /** Whether to close drawer on overlay/outside click @default `true` */
+    closeOnClickOutside?: boolean;
+
+    /** Whether to close drawer on Escape key @default `true` */
+    closeOnEscape?: boolean;
+
+    /** Whether to lock body scroll while opened @default `true` */
+    lockScroll?: boolean;
+
+    /** Whether to render overlay/content inside portal @default `true` */
+    withinPortal?: boolean;
+
+    /** Radius for drawer content @default `none` */
+    radius?: RefraktorRadius;
+
+    /** Side where drawer appears @default `right` */
+    position?: DrawerPosition;
+
+    /** Drawer size scale (width for left/right, height for top/bottom) @default `md` */
+    size?: RefraktorSize;
+
+    /** Whether to trap focus within the drawer @default `true` */
+    trapFocus?: boolean;
+
+    /** Whether to return focus to trigger after close @default `true` */
+    returnFocus?: boolean;
+
+    /** Transition props for overlay/content, uses Transition internally */
+    transitionProps?: Omit<TransitionProps, "children" | "mounted">;
+
+    /** Used for editing root class name */
+    className?: string;
+
+    /** Used for styling different parts of the component */
+    classNames?: DrawerClassNames;
+}
+
+export interface DrawerProps extends Omit<DrawerRootProps, "title"> {
+    /** Title text rendered in the header */
+    title?: ReactNode;
+
+    /** Whether to render the overlay @default `true` */
+    withOverlay?: boolean;
+
+    /** Whether to show the close button in the header @default `true` */
+    withCloseButton?: boolean;
+
+    /** Props passed to the Overlay subcomponent */
+    overlayProps?: DrawerOverlayProps;
+}
+
+export interface DrawerOverlayProps extends ComponentPropsWithoutRef<"div"> {
+    /** Whether clicking the overlay closes drawer @default `true` */
+    closeOnClick?: boolean;
+
+    /** Overlay background opacity @default `0.5` */
+    backgroundOpacity?: number;
+
+    /** Backdrop blur amount in px (or any CSS length) @default `0` */
+    blur?: number | string;
+
+    /** Used for editing root class name */
+    className?: string;
+}
+
+export interface DrawerContentProps extends ComponentPropsWithoutRef<"div"> {
+    /** Drawer body content */
+    children: ReactNode;
+
+    /** Used for editing root class name */
+    className?: string;
+}
+
+export interface DrawerHeaderProps extends ComponentPropsWithoutRef<"div"> {
+    /** Header content */
+    children?: ReactNode;
+
+    /** Shorthand header text */
+    text?: ReactNode;
+
+    /** Whether to show close button inside header @default `true` */
+    withClose?: boolean;
+
+    /** Used for editing root class name */
+    className?: string;
+}
+
+export interface DrawerBodyProps extends ComponentPropsWithoutRef<"div"> {
+    /** Body content */
+    children?: ReactNode;
+
+    /** Used for editing root class name */
+    className?: string;
+}
+
+export interface DrawerCloseProps extends Omit<
+    ComponentPropsWithoutRef<"button">,
+    "onClick"
+> {
+    /** Optional close content (defaults to `x`) */
+    children?: ReactNode;
+
+    /** Click callback fired before closing */
+    onClick?: (event: MouseEvent<HTMLButtonElement>) => void;
+
+    /** Used for editing root class name */
+    className?: string;
+}
+
+export interface DrawerFactoryPayload extends FactoryPayload {
+    props: DrawerProps;
+    ref: HTMLDivElement;
+    compound: {
+        configure: ReturnType<typeof createComponentConfig<DrawerProps>>;
+        classNames: ReturnType<typeof createClassNamesConfig<DrawerClassNames>>;
+        Root: typeof DrawerRoot;
+        Overlay: typeof DrawerOverlay;
+        Content: typeof DrawerContent;
+        Header: typeof DrawerHeader;
+        Body: typeof DrawerBody;
+        Close: typeof DrawerClose;
+    };
+}
+
+export interface DrawerRootFactoryPayload extends FactoryPayload {
+    props: DrawerRootProps;
+    ref: HTMLDivElement;
+}
+
+export interface DrawerOverlayFactoryPayload extends FactoryPayload {
+    props: DrawerOverlayProps;
+    ref: HTMLDivElement;
+}
+
+export interface DrawerContentFactoryPayload extends FactoryPayload {
+    props: DrawerContentProps;
+    ref: HTMLDivElement;
+}
+
+export interface DrawerHeaderFactoryPayload extends FactoryPayload {
+    props: DrawerHeaderProps;
+    ref: HTMLDivElement;
+}
+
+export interface DrawerBodyFactoryPayload extends FactoryPayload {
+    props: DrawerBodyProps;
+    ref: HTMLDivElement;
+}
+
+export interface DrawerCloseFactoryPayload extends FactoryPayload {
+    props: DrawerCloseProps;
+    ref: HTMLButtonElement;
+}

package/src/components/drawer/index.ts

@@ -0,0 +1,18 @@
+export { default as Drawer } from "./drawer";
+export { DrawerRoot } from "./drawer-root";
+export { DrawerOverlay } from "./drawer-overlay";
+export { DrawerContent } from "./drawer-content";
+export { DrawerHeader } from "./drawer-header";
+export { DrawerBody } from "./drawer-body";
+export { DrawerClose } from "./drawer-close";
+export type {
+    DrawerProps,
+    DrawerRootProps,
+    DrawerOverlayProps,
+    DrawerContentProps,
+    DrawerHeaderProps,
+    DrawerBodyProps,
+    DrawerCloseProps,
+    DrawerClassNames,
+    DrawerPosition
+} from "./drawer.types";

package/src/components/drawer/use-drawer.ts

@@ -0,0 +1,94 @@
+import { useUncontrolled } from "@refraktor/utils";
+import {
+    FloatingContext,
+    useDismiss,
+    useFloating,
+    useInteractions,
+    useRole
+} from "@floating-ui/react";
+import { useCallback } from "react";
+
+interface UseDrawerProps {
+    opened?: boolean;
+    defaultOpened?: boolean;
+    onOpenedChange?: (opened: boolean) => void;
+    closeOnClickOutside?: boolean;
+    closeOnEscape?: boolean;
+}
+
+export interface UseDrawerReturn {
+    opened: boolean;
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    context: FloatingContext;
+    refs: {
+        setReference: (node: HTMLElement | null) => void;
+        setFloating: (node: HTMLElement | null) => void;
+        floating: React.MutableRefObject<HTMLElement | null>;
+    };
+    getFloatingProps: (
+        userProps?: React.HTMLAttributes<HTMLElement>
+    ) => Record<string, unknown>;
+}
+
+export function useDrawer(options: UseDrawerProps): UseDrawerReturn {
+    const {
+        opened,
+        defaultOpened,
+        onOpenedChange,
+        closeOnClickOutside = true,
+        closeOnEscape = true
+    } = options;
+
+    const [isOpen, setIsOpen] = useUncontrolled({
+        value: opened,
+        defaultValue: defaultOpened,
+        finalValue: false,
+        onChange: onOpenedChange
+    });
+
+    const floating = useFloating({
+        open: isOpen,
+        onOpenChange: setIsOpen
+    });
+
+    const dismiss = useDismiss(floating.context, {
+        outsidePress: closeOnClickOutside,
+        outsidePressEvent: "mousedown",
+        escapeKey: closeOnEscape
+    });
+
+    const role = useRole(floating.context, {
+        role: "dialog"
+    });
+
+    const { getFloatingProps } = useInteractions([dismiss, role]);
+
+    const open = useCallback(() => {
+        setIsOpen(true);
+    }, [setIsOpen]);
+
+    const close = useCallback(() => {
+        setIsOpen(false);
+    }, [setIsOpen]);
+
+    const toggle = useCallback(() => {
+        setIsOpen(!isOpen);
+    }, [isOpen, setIsOpen]);
+
+    return {
+        opened: isOpen,
+        open,
+        close,
+        toggle,
+        context: floating.context,
+        refs: {
+            setReference: floating.refs.setReference,
+            setFloating: floating.refs.setFloating,
+            floating: floating.refs
+                .floating as React.MutableRefObject<HTMLElement | null>
+        },
+        getFloatingProps
+    };
+}