setIosSwipeGestureEnabled

iOS에서 화면 왼쪽 엣지를 스와이프해 뒤로가는 기본 제스처를 활성화하거나 비활성화합니다. Android에는 영향을 주지 않습니다.

시그니처

import { setIosSwipeGestureEnabled } from '@apps-in-toss/web-framework';

declare function setIosSwipeGestureEnabled(options: {
  isEnabled: boolean;
}): Promise<void>;

파라미터

이름	타입	필수	설명
options.isEnabled	boolean	✓	true이면 스와이프 뒤로가기를 활성화, false이면 비활성화합니다.

반환값

• Promise<void> — 설정이 전달되면 resolve.
• devtools mock 환경에서는 콘솔에 로그만 출력됩니다.

iOS 전용

이 API는 iOS에서만 동작합니다. Android 환경에서는 호출해도 무시됩니다.

권한

권한이 필요하지 않습니다.

예제

최소 예제

import { setIosSwipeGestureEnabled } from '@apps-in-toss/web-framework';

// 스와이프 뒤로가기 비활성화
await setIosSwipeGestureEnabled({ isEnabled: false });

실전 예제 — 결제 입력 중 실수 방지

import { setIosSwipeGestureEnabled } from '@apps-in-toss/web-framework';
import { useEffect } from 'react';

export function PaymentForm() {
  useEffect(() => {
    // 결제 입력 중에는 스와이프로 실수로 뒤로가지 않도록 비활성화
    setIosSwipeGestureEnabled({ isEnabled: false });

    return () => {
      // 화면을 벗어날 때 복원
      setIosSwipeGestureEnabled({ isEnabled: true });
    };
  }, []);

  return <form>{/* 결제 입력 폼 */}</form>;
}

직접 실행해 보기

sdk-example의 Navigation 페이지에서 setIosSwipeGestureEnabled 카드를 실행해 결과를 확인할 수 있습니다.

→sdk-example에서 실행해 보기

관련 API

• setDeviceOrientation — 화면 방향을 설정합니다.
• closeView — 현재 뷰를 닫습니다.

관련 가이드

• Guides — 미니앱 화면 흐름 패턴 — 미니앱 진입·종료, 외부 URL 열기, 화면 컨텍스트(회전·꺼짐·보안) 패턴.

외부 참조

• @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.