@zanii-id/react
v0.7.2
Published
Zanii ID login button for React — server-mode link, SPA public-client PKCE, opt-in popup sign-in
Readme
@zanii-id/react
The "Continue with Zanii ID" button for React applications.
npm install @zanii-id/reactServer-rendered apps (default)
The button is a plain link to your own backend's login route, which owns the OAuth flow and the client secret:
import { ZaniiLoginButton } from "@zanii-id/react";
<ZaniiLoginButton href="/auth/login" />Single-page apps
For a true SPA with no backend, the browser acts as a public OAuth client and runs PKCE itself with WebCrypto:
<ZaniiLoginButton
mode="spa"
issuer="https://ids.zanii.agency"
clientId="cli_..."
redirectUri="https://app.example.com/callback"
/>State and nonce live in sessionStorage, and sign-in is a full-page redirect — never a
popup or an iframe.
The browser is a public client
The component throws if any prop looks like a credential:
<ZaniiLoginButton clientSecret="..." /> // throws immediatelyA secret in browser code is a deployment mistake, so it fails loudly at development time rather than shipping.
Styling and accessibility
Renders a native <a> or <button>: real focus ring, 44px minimum target, aria-busy
while redirecting, and an error slot. Style it with className or the exposed CSS
variables — appearance is yours, security behaviour is not a prop.
import "@zanii-id/react/styles.css";Finishing the SPA flow
useZaniiSpaAuth starts the flow; on the redirect page call completeZaniiSpaLogin to
exchange the code as a public client (no secret, client_id in the body) and verify the
id_token in the browser against the issuer's JWKS (RS256, issuer, audience, expiry, nonce):
import { completeZaniiSpaLogin } from "@zanii-id/react";
const { accessToken, claims } = await completeZaniiSpaLogin({ issuer, clientId, redirectUri });Keep the tokens in memory only. A browser holds no refresh token; re-run login() when the
access token expires.
Popup mode (opt-in)
Redirect is the default and the right choice almost always: the whole tab goes to the
issuer, the user sees ids.zanii.agency in the address bar, and it works in every browser.
Popup mode keeps your page mounted instead, which is worth it when the user is midway
through something you would rather not unmount.
<ZaniiLoginButton
mode="spa"
popup // opt in; omit for a redirect
issuer="https://ids.zanii.agency"
clientId="cli_..."
redirectUri="https://app.example.com/auth/callback"
onSignedIn={(session) => setUser(session.claims)}
/>or from the hook:
const auth = useZaniiSpaAuth({ issuer, clientId, redirectUri, mode: "popup" });
const session = await auth.login(); // resolves when the popup hands the sign-in backYour callback page serves both modes:
useEffect(() => {
completeZaniiSpaLogin({ issuer, clientId, redirectUri })
.then((session) => (isZaniiPopupCallback() ? publishZaniiPopupResult(session) : setUser(session)))
.catch((err) => (isZaniiPopupCallback() ? publishZaniiPopupResult(err) : setError(err.message)));
}, []);What it does about the awkward cases
| Case | Behaviour |
|---|---|
| The browser blocks the popup | falls back to a full-page redirect, so the user is never stuck. Pass onPopupBlocked="error" to surface it instead |
| The user closes the window | login() rejects with PopupClosedError; nothing is left running |
| Nobody finishes | PopupTimeoutError after five minutes (popupTimeoutMs), and the window is closed |
| A mobile browser opens a tab and refuses to close it | after handing back the result the callback navigates to / (fallbackUrl) rather than stranding the user on a blank page |
| Your app sends a Cross-Origin-Opener-Policy header | still works: the handoff rides a same-origin BroadcastChannel, not window.opener |
| The browser has no BroadcastChannel | popup mode quietly becomes a redirect |
The result never leaves your origin: the popup lands on your redirect URI, so the channel
carrying it is same-origin, and a message whose state is not the one this flow issued is
ignored. Whichever mode you choose, the password, the second factor and the passkey happen on
the issuer's own origin and your app only ever sees tokens it verified itself.
Licence
Apache-2.0. See LICENSE.
