Exemplos de integração de frontend
O widget é um elemento personalizado padrão, então funciona em todo framework sem nenhum wrapper para instalar. O formato é sempre o mesmo: carregue o pacote uma vez (integração no lado do cliente), renderize <caputchin-widget sitekey="cpt_pub_..."> dentro do seu formulário e leia o campo oculto caputchin-token que ele injeta quando o visitante resolve o desafio. Para um jogo, troque por <caputchin-game ... game="caputchin/games/leaf-memory">.
Os exemplos abaixo diferem só na sintaxe de cada framework e na sua peculiaridade de elemento personalizado.
HTML puro
O campo injetado vai junto em um POST de formulário normal, então não há nada para conectar:
<script src="https://cdn.jsdelivr.net/npm/@caputchin/widget@3/dist/widget.js"></script>
<form action="/contact" method="POST">
<input name="email" type="email" required />
<caputchin-widget sitekey="cpt_pub_..."></caputchin-widget>
<button type="submit">Send</button>
</form>React
Importe uma vez na inicialização, depois leia o campo de FormData no envio:
import "@caputchin/widget";
export function ContactForm() {
async function handleSubmit(e) {
e.preventDefault();
const data = new FormData(e.currentTarget);
await fetch("/api/contact", {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify({ email: data.get("email"), token: data.get("caputchin-token") }),
});
}
return (
<form onSubmit={handleSubmit}>
<input name="email" type="email" required />
<caputchin-widget sitekey="cpt_pub_..." />
<button type="submit">Send</button>
</form>
);
}Se você usa TypeScript com React, declare os dois elementos uma vez para que o JSX os aceite:
// caputchin.d.ts
import type { DetailedHTMLProps, HTMLAttributes } from "react";
declare module "react" {
namespace JSX {
interface IntrinsicElements {
"caputchin-widget": DetailedHTMLProps<HTMLAttributes<HTMLElement> & { sitekey: string }, HTMLElement>;
"caputchin-game": DetailedHTMLProps<HTMLAttributes<HTMLElement> & { sitekey: string; game?: string; games?: string }, HTMLElement>;
}
}
}Esta forma declare module "react" é específica do JSX do React. Em TypeScript puro os elementos são apenas HTMLElement e não precisam de declaração, e os outros frameworks abaixo tipam elementos personalizados do seu próprio jeito, então você só precisa deste bloco em um projeto React.
Vue
Diga ao compilador do Vue que as tags caputchin- são elementos personalizados, para que ele não tente resolvê-las como componentes:
// vite.config.js
export default {
plugins: [vue({ template: { compilerOptions: { isCustomElement: (tag) => tag.startsWith("caputchin-") } } })],
};<script setup>
import "@caputchin/widget";
function onSubmit(e) {
const data = new FormData(e.target);
// send data.get("caputchin-token") to your backend
}
</script>
<template>
<form @submit.prevent="onSubmit">
<input name="email" type="email" required />
<caputchin-widget sitekey="cpt_pub_..."></caputchin-widget>
<button type="submit">Send</button>
</form>
</template>Svelte
O Svelte renderiza elementos personalizados como estão, sem config necessária:
<script>
import "@caputchin/widget";
function onSubmit(e) {
const data = new FormData(e.currentTarget);
// send data.get("caputchin-token") to your backend
}
</script>
<form on:submit|preventDefault={onSubmit}>
<input name="email" type="email" required />
<caputchin-widget sitekey="cpt_pub_..."></caputchin-widget>
<button type="submit">Send</button>
</form>Angular
Adicione CUSTOM_ELEMENTS_SCHEMA ao módulo ou ao componente standalone para que o Angular permita a tag desconhecida, e importe o pacote uma vez (em main.ts):
import { Component, CUSTOM_ELEMENTS_SCHEMA } from "@angular/core";
import "@caputchin/widget";
@Component({
selector: "contact-form",
schemas: [CUSTOM_ELEMENTS_SCHEMA],
template: `
<form (submit)="onSubmit($event)">
<input name="email" type="email" required />
<caputchin-widget sitekey="cpt_pub_..."></caputchin-widget>
<button type="submit">Send</button>
</form>
`,
})
export class ContactFormComponent {
onSubmit(e: Event) {
const data = new FormData(e.target as HTMLFormElement);
// send data.get("caputchin-token") to your backend
}
}Next.js
O mesmo código React funciona. O elemento personalizado renderiza como uma tag vazia durante a renderização no servidor e faz upgrade no cliente assim que o pacote carrega, então nenhum tratamento especial é necessário além de importar @caputchin/widget em um componente de cliente (ou carregar o script do CDN com next/script).
Veja também
- Integração no lado do cliente para as opções de carregamento.
- Integração no lado do servidor para a metade do backend.