cardano-tessera-respond-react
v0.9.0
Published
React bindings for the <tessera-respond> CIP-179 survey widget: one typed component that registers the element, syncs props as DOM properties, and delivers the tessera:* events as onResponse / onChange / onInvalid callbacks. Works identically on React 18
Maintainers
Readme
cardano-tessera-respond-react
React bindings for cardano-tessera-respond,
the embeddable <tessera-respond> CIP-179 survey widget.
The custom element needs two things React's JSX can't give it directly: its
object-valued props must be set as DOM properties (React ≤18 writes
unknown JSX props as HTML attributes), and its tessera:* CustomEvents need
real addEventListener calls on any React version. <TesseraRespond> does
both through a ref, identically on React 18 and 19.
npm install cardano-tessera-respond-react cardano-tessera-respondThe two packages are released together under one version number, and this one requires the widget of that exact version: install and update them as a pair.
import { TesseraRespond } from "cardano-tessera-respond-react";
function Survey({ definition, surveyRef, responder, tipEpoch }) {
return (
<TesseraRespond
definition={definition}
surveyRef={surveyRef}
responder={responder}
tipEpoch={tipEpoch}
onResponse={({ payload, proveCredentials }) => {
// 1. attach `payload` at metadata label 17
// 2. prove each credential (required_signers / governance vote)
// 3. sign with the wallet, submit
}}
/>
);
}Importing the package registers the element (a no-op without a DOM, so plain imports are safe under Next.js and other SSR setups; the element upgrades and renders client-side).
Props
Every widget prop, with the same names, types, and semantics; see the
widget README
for the full contract. The four required ones are definition, surveyRef,
responder, and tipEpoch. On top of those:
| Prop | Replaces the event |
| ---------------------------- | ------------------ |
| onResponse={(detail) => …} | tessera:response |
| onChange={(detail) => …} | tessera:change |
| onInvalid={(detail) => …} | tessera:invalid |
Callback details are fully typed (RespondResult, RespondChangeDetail,
RespondInvalidDetail re-export from here). className, id, and style
pass through to the host element; style the widget itself via its
--tessera-* design tokens.
ref exposes the underlying TesseraRespondElement.
Keep object props (definition, stash, translations, conditions, …)
the same object across renders (a module constant, state, or useMemo)
rather than a literal in JSX. The widget skips a same-reference write, but a
new object is read again: a faulty translations, noneLabels, or
conditions document logs its console warnings on every render.
Note the widget announces progress as soon as it renders, so onChange fires
once on mount with the initial RespondChangeDetail.
Working example
A minimal Vite app lives at
examples/react-host
in the repository; it is built in CI against the current widget.
License
Apache-2.0
