Navigation API

Toss POS에서 페이지를 이동하기 위한 인터페이스를 제공해요. 플러그인 설정 탭, 업종유형 변경 화면, 배달앱 설정 화면으로 이동할 수 있어요.

Methods

navigate

POS에서 지정한 페이지로 이동해요.

import { posPluginSdk } from '@tossplace/pos-plugin-sdk';

posPluginSdk.navigation.navigate('plugin-setting-tab', packageName);

Parameters

파라미터	타입	필수	설명
page	'plugin-setting-tab' | 'business-type-setting' | 'delivery-connection' | 'plugin-tab'	O	이동할 페이지 종류
packageName	string	X	이동할 탭의 이름. page가 'plugin-setting-tab'이면 반드시 넣어야 하고, 'plugin-tab'이면 선택이에요. 다른 page에서는 사용하지 않아요

Response

반환값이 없어요.

page 종류

• plugin-setting-tab: packageName으로 지정한 플러그인의 설정 탭으로 이동해요.
• business-type-setting: 업종유형 변경 화면으로 이동해요.
• delivery-connection: 설정 > 배달앱 화면으로 이동해요.
• plugin-tab (deprecated): 플러그인 탭으로 이동해요. packageName으로 특정 탭을 지정할 수 있고, 없는 경우 첫 번째 플러그인 탭으로 이동해요.

plugin-tab은 deprecated 됐어요

0.0.29부터 plugin-tab은 deprecated 됐어요. 새로 개발하는 플러그인에서는 plugin-setting-tab을 사용해주세요.

사용 예시

플러그인 설정 탭으로 이동

import { posPluginSdk } from '@tossplace/pos-plugin-sdk';

posPluginSdk.navigation.navigate('plugin-setting-tab', 'my-plugin');

업종유형 변경 화면으로 이동

import { posPluginSdk } from '@tossplace/pos-plugin-sdk';

posPluginSdk.navigation.navigate('business-type-setting');

배달앱 설정 화면으로 이동

import { posPluginSdk } from '@tossplace/pos-plugin-sdk';

posPluginSdk.navigation.navigate('delivery-connection');