partner.removeAccessoryButton

partner.addAccessoryButton으로 추가한 악세서리 버튼을 상단 네비게이션 바에서 제거합니다. 화면을 떠날 때 cleanup으로 호출하는 것이 일반적입니다.

시그니처

removeAccessoryButton은 partner 네임스페이스 객체의 멤버로 노출됩니다. 함수 자체를 단독으로 import하지 않습니다.

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

declare const partner: {
  removeAccessoryButton(): Promise<void>;
};

파라미터

없음.

반환값

• Promise<void> — 버튼이 제거되면 resolve.

권한

권한이 필요하지 않습니다 — partner.removeAccessoryButton은 별도의 PermissionName에 바인딩되지 않습니다. 권한이 필요한 다른 네임스페이스의 일반적인 처리 흐름은 Guides — 권한 처리 패턴을 참고하세요.

예제

최소 예제

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

await partner.removeAccessoryButton();

실전 예제 — useEffect cleanup에서 제거

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

function ProductDetailPage() {
  useEffect(() => {
    partner.addAccessoryButton({
      id: 'btn-share',
      title: '공유',
      icon: { name: 'icon-share-mono' },
    });

    return () => {
      // 화면을 벗어날 때 버튼을 정리합니다.
      partner.removeAccessoryButton();
    };
  }, []);

  return <main>{/* 페이지 콘텐츠 */}</main>;
}

직접 실행해 보기

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

→sdk-example에서 실행해 보기

관련 API

• partner.addAccessoryButton — 상단 네비게이션에 악세서리 버튼을 추가합니다.

관련 가이드

• Guides — 악세서리 버튼 UX — addAccessoryButton/removeAccessoryButton과 navigationAccessoryEvent 구독의 라이프사이클·id 라우팅·멀티 버튼·상태 토글까지 한 곳에 정리한 가이드.

외부 참조

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