onOpenUrl

onOpenUrl(handler): Promise<UnlistenFn>

Defined in: index.ts:99

Helper function for the deep-link://new-url event to run a function each time the protocol is triggered while the app is running. Use getCurrent on app load to check whether your app was started via a deep link.

Parameters

handler

(urls) => void

Returns

Promise<UnlistenFn>

Example

import { onOpenUrl } from '@tauri-apps/plugin-deep-link';
await onOpenUrl((urls) => { console.log(urls) });

- Windows / Linux: Unsupported without the single-instance plugin. The OS will spawn a new app instance passing the URL as a CLI argument.

Since

2.0.0