Skip to content
./src/assets/bp-logo.svg.Carbon

Deep Link

Terminal window
carbon add plugin DeepLink

Register schemes in bundle.protocols:

{
  "bundle": {
    "protocols": [{ "name": "Notes URL", "schemes": ["carbon-notes"] }]
  }
}
import { deepLink } from '@dotcarbon/plugin-deep-link'


const pending = await deepLink.getPending()
const stop = await deepLink.onOpen(url => routeUrl(url))

The plugin queues URLs received before the frontend subscribes and emits deep-link:opened for later launches. Pair it with Single Instance so a second process forwards URLs to the running app.