Menu Sheet

Swipeable Menu Sheet를 Stackflow와 함께 사용하는 방법을 안내합니다.

사용 가능 버전@seed-design/[email protected], @seed-design/[email protected], @seed-design/[email protected]

Swipeable Menu Sheet

Swipeable Menu Sheet 컴포넌트에 대해 자세히 알아봅니다.

일반적인 경우 Swipeable Menu Sheet를 Activity로 만들어 사용하는 것을 권장합니다.

Activity로 관리되므로, 하위 Activity보다 높고 상위 Activity보다는 낮은 z-index를 갖도록 관리하기 쉽습니다.
딥링킹이 가능합니다. (URL 접속으로 Swipeable Menu Sheet를 열 수 있습니다.)
@stackflow/plugin-basic-ui BottomSheet에서의 마이그레이션이 쉽습니다.

ActivityMenuSheetActivity.tsx

import { VStack } from "@seed-design/react";
import { useFlow, type StaticActivityComponentType } from "@stackflow/react/future";
import { IconHouseLine } from "@karrotmarket/react-monochrome-icon";
import {
  AppBar,
  AppBarBackButton,
  AppBarIconButton,
  AppBarLeft,
  AppBarMain,
  AppBarRight,
} from "seed-design/ui/app-bar";
import { AppScreen, AppScreenContent } from "seed-design/ui/app-screen";
import { ActionButton } from "seed-design/ui/action-button";

declare module "@stackflow/config" {
  interface Register {
    ActivityMenuSheetActivity: {};
  }
}

const ActivityMenuSheetActivity: StaticActivityComponentType<"ActivityMenuSheetActivity"> = () => {
  const { push } = useFlow();

  return (
    <AppScreen>
      <AppBar>
        <AppBarLeft>
          <AppBarBackButton />
        </AppBarLeft>
        <AppBarMain title="Activity" />
        <AppBarRight>
          <AppBarIconButton aria-label="Home" onClick={() => push("ActivityHome", {})}>
            <IconHouseLine />
          </AppBarIconButton>
        </AppBarRight>
      </AppBar>
      <AppScreenContent>
        <VStack p="x5" justify="center" gap="x4">
          <ActionButton
            variant="neutralSolid"
            flexGrow
            onClick={() => push("ActivityMenuSheetSimple", {})}
          >
            ActivityMenuSheetSimple을 Push
          </ActionButton>
          <ActionButton
            variant="neutralWeak"
            flexGrow
            onClick={() => push("ActivityMenuSheetActivity", {})}
          >
            지금 열린 이 Activity를 Push
          </ActionButton>
        </VStack>
      </AppScreenContent>
    </AppScreen>
  );
};

export default ActivityMenuSheetActivity;

ActivityMenuSheetSimple.tsx

import { useActivityZIndexBase } from "@seed-design/stackflow";
import { useActivity, useFlow, type StaticActivityComponentType } from "@stackflow/react/future";
import {
  IconPencilLine,
  IconPlusLine,
  IconTrashcanLine,
} from "@karrotmarket/react-monochrome-icon";
import {
  SwipeableMenuSheetContent,
  SwipeableMenuSheetGroup,
  SwipeableMenuSheetItem,
  SwipeableMenuSheetRoot,
} from "seed-design/ui/swipeable-menu-sheet";
import { Snackbar, useSnackbarAdapter } from "seed-design/ui/snackbar";

declare module "@stackflow/config" {
  interface Register {
    ActivityMenuSheetSimple: {};
  }
}

const ActivityMenuSheetSimple: StaticActivityComponentType<"ActivityMenuSheetSimple"> = () => {
  const { pop } = useFlow();
  const activity = useActivity();
  const snackbar = useSnackbarAdapter();

  const handleAction = (action: string) => {
    snackbar.create({
      render: () => <Snackbar variant="positive" message={`선택한 액션: ${action}`} />,
    });
    pop();
  };

  return (
    <SwipeableMenuSheetRoot open={activity.isActive} onOpenChange={(open) => !open && pop()}>
      <SwipeableMenuSheetContent title="Actions" layerIndex={useActivityZIndexBase()}>
        <SwipeableMenuSheetGroup>
          <SwipeableMenuSheetItem
            onClick={() => handleAction("add")}
            label="추가"
            prefixIcon={<IconPlusLine />}
          />
          <SwipeableMenuSheetItem
            onClick={() => handleAction("edit")}
            label="수정"
            prefixIcon={<IconPencilLine />}
          />
          <SwipeableMenuSheetItem
            onClick={() => handleAction("delete")}
            tone="critical"
            label="삭제"
            prefixIcon={<IconTrashcanLine />}
          />
        </SwipeableMenuSheetGroup>
      </SwipeableMenuSheetContent>
    </SwipeableMenuSheetRoot>
  );
};

export default ActivityMenuSheetSimple;

Usage

import { useActivityZIndexBase } from "@seed-design/stackflow";
import { useActivity, useFlow, type ActivityComponentType } from "@stackflow/react/future";
// ... more imports

const ActivitySwipeableMenuSheet: ActivityComponentType<"ActivitySwipeableMenuSheet"> = () => {
  const { pop } = useFlow();

  const handleAction = (action: string) => {
    console.log("선택한 액션:", action);

    pop();
  };

  return (
    <SwipeableMenuSheetRoot open={useActivity().isActive} onOpenChange={(open) => !open && pop()}>
      <SwipeableMenuSheetContent
        title="Actions"
        layerIndex={useActivityZIndexBase()}
      >
        <SwipeableMenuSheetGroup>
          <SwipeableMenuSheetItem
            onClick={() => handleAction("add")}
            label="추가"
            prefixIcon={<IconPlusLine />}
          />
          <SwipeableMenuSheetItem
            onClick={() => handleAction("edit")}
            label="수정"
            prefixIcon={<IconPencilLine />}
          />
          <SwipeableMenuSheetItem
            onClick={() => handleAction("delete")}
            tone="critical"
            label="삭제"
            prefixIcon={<IconTrashcanLine />}
          />
        </SwipeableMenuSheetGroup>
      </SwipeableMenuSheetContent>
    </SwipeableMenuSheetRoot>
  );
};

open prop에 useActivity().isActive를 전달하여 Activity가 활성화될 때 Swipeable Menu Sheet가 열리도록 합니다.
onOpenChange를 통해 Swipeable Menu Sheet가 닫힐 때 pop()을 실행하여 Activity를 종료합니다. swipe 제스처로 닫는 경우에도 onOpenChange가 호출되므로 Activity가 함께 종료됩니다.
layerIndex={useActivityZIndexBase()}로 Swipeable Menu Sheet Activity의 z-index 기준점을 전달합니다.

useActivityZIndexBase에 대해 자세히 알아보기

Swipeable Menu Sheet를 Activity로 만들 수 없는 경우, Swipeable Menu Sheet가 표시된 상태를 Step으로 만들 수 있습니다.

현재 Activity를 유지하면서도, 뒤로 가기 버튼 등으로 Swipeable Menu Sheet를 닫을 수 있습니다.
SwipeableMenuSheetTrigger를 사용하여 Swipeable Menu Sheet를 열고 닫을 수 있습니다.

제약 사항

Activity로 만들지 않은 Swipeable Menu Sheet에서 다른 Activity를 push하는 경우, push하기 전 Swipeable Menu Sheet를 닫으세요.

Swipeable Menu Sheet를 닫을 수 없거나, Swipeable Menu Sheet를 연 Activity로 돌아왔을 때 Swipeable Menu Sheet가 열린 상태를 유지해야 하는 경우 Swipeable Menu Sheet를 Activity로 만들어 사용하는 것을 권장합니다.

Activity 간 유려한 트랜지션을 제공하기 위해 하위 AppScreen 요소 중 일부가 상위 AppScreen 요소보다 위에 위치합니다. 이 제약으로 인해, 열린 상태의 Swipeable Menu Sheet는 독립적인 Activity로 만들지 않는 경우 하위 Activity와 상위 Activity 사이에 위치시키는 것이 불가능합니다.

ActivityMenuSheetStep.tsx

import { Portal, VStack } from "@seed-design/react";
import { useActivityZIndexBase } from "@seed-design/stackflow";
import {
  useActivityParams,
  useFlow,
  useStepFlow,
  type StaticActivityComponentType,
} from "@stackflow/react/future";
import { useEffect, useState } from "react";
import { ActionButton } from "seed-design/ui/action-button";
import { AppBar, AppBarIconButton, AppBarMain, AppBarRight } from "seed-design/ui/app-bar";
import { AppScreen, AppScreenContent } from "seed-design/ui/app-screen";
import {
  SwipeableMenuSheetContent,
  SwipeableMenuSheetGroup,
  SwipeableMenuSheetItem,
  SwipeableMenuSheetRoot,
  SwipeableMenuSheetTrigger,
} from "seed-design/ui/swipeable-menu-sheet";
import {
  IconHouseLine,
  IconPencilLine,
  IconPlusLine,
  IconTrashcanLine,
} from "@karrotmarket/react-monochrome-icon";
import { Snackbar, useSnackbarAdapter } from "seed-design/ui/snackbar";

declare module "@stackflow/config" {
  interface Register {
    ActivityMenuSheetStep: {
      "menu-sheet"?: "open";
    };
  }
}

const ActivityMenuSheetStep: StaticActivityComponentType<"ActivityMenuSheetStep"> = () => {
  const [open, setOpen] = useState(false);
  const { push } = useFlow();
  const { pushStep, popStep } = useStepFlow("ActivityMenuSheetStep");
  const params = useActivityParams<"ActivityMenuSheetStep">();
  const isOverlayOpen = params["menu-sheet"] === "open";
  const snackbar = useSnackbarAdapter();

  useEffect(() => setOpen(isOverlayOpen), [isOverlayOpen]);

  const onOpenChange = (newOpen: boolean) => {
    setOpen(newOpen);

    if (newOpen && !isOverlayOpen) {
      pushStep((params) => ({ ...params, "menu-sheet": "open" }));
      return;
    }

    if (!newOpen && isOverlayOpen) {
      popStep();
      return;
    }
  };

  const handleAction = (action: string) => {
    snackbar.create({
      render: () => <Snackbar variant="positive" message={`선택한 액션: ${action}`} />,
    });
    setOpen(false);
  };

  return (
    <AppScreen>
      <AppBar>
        <AppBarMain title="Step" />
        <AppBarRight>
          <AppBarIconButton aria-label="Home" onClick={() => push("ActivityHome", {})}>
            <IconHouseLine />
          </AppBarIconButton>
        </AppBarRight>
      </AppBar>
      <AppScreenContent>
        <SwipeableMenuSheetRoot open={open} onOpenChange={onOpenChange}>
          <SwipeableMenuSheetTrigger asChild>
            <VStack p="x5" justify="center" gap="x4">
              <ActionButton variant="neutralSolid" flexGrow>
                Menu Sheet 열기
              </ActionButton>
            </VStack>
          </SwipeableMenuSheetTrigger>
          <Portal>
            <SwipeableMenuSheetContent
              title="Step"
              layerIndex={useActivityZIndexBase({ activityOffset: 1 })}
            >
              <SwipeableMenuSheetGroup>
                <SwipeableMenuSheetItem
                  onClick={() => handleAction("add")}
                  label="추가"
                  prefixIcon={<IconPlusLine />}
                />
                <SwipeableMenuSheetItem
                  onClick={() => handleAction("edit")}
                  label="수정"
                  prefixIcon={<IconPencilLine />}
                />
                <SwipeableMenuSheetItem
                  onClick={() => handleAction("delete")}
                  tone="critical"
                  label="삭제"
                  prefixIcon={<IconTrashcanLine />}
                />
              </SwipeableMenuSheetGroup>
              <SwipeableMenuSheetGroup labelAlign="center">
                <SwipeableMenuSheetItem
                  onClick={() => {
                    // 이 Menu Sheet는 Activity로 만들어지지 않았기 때문에, z-index 정리를 위해
                    // Menu Sheet를 먼저 닫고 다음 Activity를 push해야 합니다.
                    setOpen(false);
                    push("ActivityDetail", {
                      title: "Menu Sheet에서 이동한 화면",
                      body: "Menu Sheet를 닫고 이동했습니다.",
                    });
                  }}
                  label="Push"
                />
              </SwipeableMenuSheetGroup>
            </SwipeableMenuSheetContent>
          </Portal>
        </SwipeableMenuSheetRoot>
      </AppScreenContent>
    </AppScreen>
  );
};

export default ActivityMenuSheetStep;

Usage

import { useActivityZIndexBase } from "@seed-design/stackflow";
import { Portal } from "@seed-design/react";
import {
  useActivity,
  useActivityParams,
  useFlow,
  useStepFlow,
  type ActivityComponentType,
} from "@stackflow/react/future";
import { useEffect, useState } from "react";
// ... more imports

declare module "@stackflow/config" {
  interface Register {
    ActivityHome: {
      "menu-sheet"?: "open";
    };
  }
}

const ActivityHome: ActivityComponentType<"ActivityHome"> = () => {
  const [open, setOpen] = useState(false);

  const { push } = useFlow();
  const { pushStep, popStep } = useStepFlow("ActivityHome");
  const params = useActivityParams<"ActivityHome">();
  const isOverlayOpen = params["menu-sheet"] === "open";

  useEffect(() => {
    if (!isOverlayOpen) {
      setOpen(false);
    }
  }, [isOverlayOpen]);

  const onOpenChange = (newOpen: boolean) => {
    setOpen(newOpen);

    if (newOpen && !isOverlayOpen) {
      pushStep((params) => ({ ...params, "menu-sheet": "open" }));

      return;
    }

    if (!newOpen && isOverlayOpen) {
      popStep();

      return;
    }
  };

  const handleAction = (action: string) => {
    console.log("선택한 액션:", action);
    setOpen(false);
  };

  return (
    <AppScreen>
      <SwipeableMenuSheetRoot open={open} onOpenChange={onOpenChange}>
        <SwipeableMenuSheetTrigger asChild>
          <ActionButton>Open</ActionButton>
        </SwipeableMenuSheetTrigger>
        <Portal>
          <SwipeableMenuSheetContent
            title="Actions"
            layerIndex={useActivityZIndexBase({ activityOffset: 1 })}
          >
            <SwipeableMenuSheetGroup>
              <SwipeableMenuSheetItem onClick={() => handleAction("add")} label="추가" />
              <SwipeableMenuSheetItem onClick={() => handleAction("edit")} label="수정" />
              <SwipeableMenuSheetItem
                onClick={() => {
                  setOpen(false); // 다른 Activity로 이동하기 전에는 Swipeable Menu Sheet를 닫으세요.
                  push("ActivityNext");
                }}
                label="Push"
              />
              <SwipeableMenuSheetItem
                onClick={() => handleAction("delete")}
                tone="critical"
                label="삭제"
              />
            </SwipeableMenuSheetGroup>
          </SwipeableMenuSheetContent>
        </Portal>
      </SwipeableMenuSheetRoot>
    </AppScreen>
  );
};

Portal을 사용하여 Swipeable Menu Sheet가 DOM 상 현재 Activity 밖에 렌더링되도록 합니다.
open prop를 관리하고, onOpenChange 핸들러를 통해 Step 상태와 동기화합니다.
뒤로 가기 버튼 등을 통해 Activity 파라미터가 변경될 때 Swipeable Menu Sheet의 open 상태를 동기화합니다.
layerIndex={useActivityZIndexBase({ activityOffset: 1 })}로 현재 Activity보다 한 단계 높은 z-index 기준점을 전달합니다.
- useActivityZIndexBase에 대해 자세히 알아보기

`useStepOverlay`

#2와 #3을 일반화하여 useStepOverlay를 사용하면 편리합니다. useStepOverlay 구현 예시는 코드를 참고하세요.

import { useActivityZIndexBase } from "@seed-design/stackflow";
import { Portal } from "@seed-design/react";
import { useStepOverlay } from "./use-step-overlay";
// ... more imports

const MyActivity: ActivityComponentType = () => {
  const { overlayProps, setOpen } = useStepOverlay();
  const { popStep } = useStepFlow("MyActivity");
  const { push } = useFlow();

  const handleAction = (action: string) => {
    console.log("선택한 액션:", action);
    popStep();
  };

  return (
    <AppScreen>
      <SwipeableMenuSheetRoot {...overlayProps}>
        <SwipeableMenuSheetTrigger asChild>
          <ActionButton>Open</ActionButton>
        </SwipeableMenuSheetTrigger>
        <Portal>
          <SwipeableMenuSheetContent
            title="Actions"
            layerIndex={useActivityZIndexBase({ activityOffset: 1 })}
          >
            <SwipeableMenuSheetGroup>
              <SwipeableMenuSheetItem onClick={() => handleAction("add")} label="추가" />
              <SwipeableMenuSheetItem onClick={() => handleAction("edit")} label="수정" />
              <SwipeableMenuSheetItem
                onClick={() => {
                  setOpen(false); // 다른 Activity로 이동하기 전에는 Swipeable Menu Sheet를 닫으세요.
                  push("ActivityNext");
                }}
                label="Push"
              />
              <SwipeableMenuSheetItem
                onClick={() => handleAction("delete")}
                tone="critical"
                label="삭제"
              />
            </SwipeableMenuSheetGroup>
          </SwipeableMenuSheetContent>
        </Portal>
      </SwipeableMenuSheetRoot>
    </AppScreen>
  );
};

About `useActivityZIndexBase`

useActivityZIndexBase는 각 Activity의 z-index 기준점을 반환하는 훅입니다.

useActivity().zIndex * 5를 반환합니다. useActivity().zIndex는 현재 Activity가 enter된 Activity 중 몇 번째 Activity인지를 나타내는 값입니다.

AppScreen을 구성하는 요소들(layer, appbar, dim, edge)은 useActivityZIndexBase() 값을 바탕으로 계산된 z-index를 갖습니다.

┌─ 2번 BottomSheet Activity
│  └─ BottomSheet: 12 (2 × 5 + 2)
├─ 1번 AppScreen Activity
│  ├─ appbar: 12 (1 × 5 + 7)
│  ├─ edge: 9 (1 × 5 + 4)
│  ├─ layer: 7 (1 × 5 + 2)
│  └─ dim: 5 (1 × 5 + 0)
└─ 0번 AppScreen Activity
   ├─ appbar: 7 (0 × 5 + 7)
   ├─ edge: 4 (0 × 5 + 4)
   ├─ layer: 2 (0 × 5 + 2)
   └─ dim: 0 (0 × 5 + 0)

activityOffset 옵션은 현재 Activity가 아닌 다음 Activity의 z-index 기준점을 사용하고 싶을 때 사용합니다.
예를 들어, useActivityZIndexBase({ activityOffset: 1 })는 다음 Activity의 z-index 기준점을 반환합니다.

이는 Step 패턴에서 현재 Activity 위에 BottomSheet를 표시할 때 유용합니다.

┌─ 1번 AppScreen Activity에서 activityOffset: 1로 띄운 BottomSheet (예: Step 패턴)
│  └─ BottomSheet: 12 ((1 + 1) × 5 + 2)
├─ 1번 AppScreen Activity
│  ├─ appbar: 12 (1 × 5 + 7)
│  ├─ edge: 9 (1 × 5 + 4)
│  ├─ layer: 7 (1 × 5 + 2)
│  └─ dim: 5 (1 × 5 + 0)
└─ 0번 AppScreen Activity
   ├─ appbar: 7 (0 × 5 + 7)
   ├─ edge: 4 (0 × 5 + 4)
   ├─ layer: 2 (0 × 5 + 2)
   └─ dim: 0 (0 × 5 + 0)

Menu Sheet

Swipeable Menu Sheet

Making a Swipeable Menu Sheet Activity

Usage

Syncing Swipeable Menu Sheet State with a Step

Usage

`useStepOverlay`

About `useActivityZIndexBase`

목차

Menu Sheet

Swipeable Menu Sheet

Making a Swipeable Menu Sheet ActivityCopy Anchor Link

UsageCopy Anchor Link

Syncing Swipeable Menu Sheet State with a StepCopy Anchor Link

UsageCopy Anchor Link

useStepOverlayCopy Anchor Link

About useActivityZIndexBaseCopy Anchor Link

useActivityZIndexBase는 어떤 값을 반환하나요?

activityOffset 옵션은 무엇인가요?

@stackflow/react-ui-core useZIndexBase와 @seed-design/stackflow useActivityZIndexBase는 어떻게 다른가요?

기존에 layerIndex에 수동으로 z-index 값을 지정해주던 코드는 어떻게 변경해야 하나요?

목차

Making a Swipeable Menu Sheet Activity

Usage

Syncing Swipeable Menu Sheet State with a Step

Usage

`useStepOverlay`

About `useActivityZIndexBase`