Svelte (@frontmail/svelte)

npm install @frontmail/svelte

Requires Svelte 5. Works in SvelteKit (in the browser).

createFrontmail

Create one instance, for example in src/lib/frontmail.ts:

import { createFrontmail } from '@frontmail/svelte';

export const frontmail = createFrontmail({ publicKey: 'pk_4f2a…', blockHeadless: true });

The instance has send, sendForm, getStatus, reset, and two stores: state ({ status, error, result } of the latest send) and status. The first instance created becomes the default for the action and component.

<script>
  import { frontmail } from '$lib/frontmail';
  const { status } = frontmail;
</script>

<button onclick={() => frontmail.send('svc_01J9…', 'tpl_ping', { note: 'Hi' })}>Send</button>
<p>{$status}</p>

use:frontmailForm

Turns any form into a Frontmail form:

<script>
  import { frontmailForm } from '@frontmail/svelte';
  let status = $state('idle');
</script>

<form
  use:frontmailForm={{
    serviceId: 'svc_01J9…',
    templateId: 'tpl_contact',
    turnstileSiteKey: 'YOUR_TURNSTILE_SITE_KEY',
    onState: (s) => (status = s.status),
  }}
>
  <input name="name" required />
  <input name="email" type="email" required />
  <textarea name="message" required></textarea>
  <button disabled={status === 'sending'}>Send</button>
</form>

Parameters: serviceId, templateId, frontmail (instance), turnstileSiteKey, turnstileOptions, sendOptions, resetOnSuccess (default true), onSuccess, onError, onState. The form also gets a data-status attribute you can style.

turnstileSiteKey is the site key of your own Turnstile widget (Security → Bot protection (Turnstile) in the dashboard) – see Cloudflare Turnstile. Leave it out if the template doesn’t require a CAPTCHA.

FrontmailForm.svelte

<script>
  import { FrontmailForm } from '@frontmail/svelte';
</script>

<FrontmailForm serviceId="svc_01J9…" templateId="tpl_contact" turnstileSiteKey="YOUR_TURNSTILE_SITE_KEY">
  <input name="email" type="email" required />
  <textarea name="message" required></textarea>
  <button>Send</button>
</FrontmailForm>

Example project: examples/svelte.