Skip to content
Nuni v1 is here: Figma-style comments on your real site.Get started
Nuni
Esc
↑↓navigate↵open⌘Jpreview
On this page

Options

Everything init() and the Nuni component accept.

import { init } from "@nuniapp/widget"

const instance = init({
  project: "nuni_...", // required
})
instance.destroy()
PropType
projectstring

Your public project ID. Commit it; it is not a secret.

Typestring
getPageKey?(url: URL) => string

Which URLs share comments. Defaults to the normalized path.

Type(url: URL) => string
convexUrl?string

Self-hosting or local development: the Convex deployment URL.

Typestring
convexSiteUrl?string

Self-hosting or local development: the Convex HTTP actions URL.

Typestring
appUrl?string

Self-hosting or local development: where the dashboard is served.

Typestring

<Nuni /> from @nuniapp/react takes the same props.

Keyboard

Key Action
C Start or stop adding a comment
Esc Cancel, close the comment, then the panel
Cmd + Enter Post the comment

Was this page helpful?