Skip to content

Settings

Settings sending domain

The sending-domain block in space notification settings, covering the sender-address field, a collapsible DNS authentication table, and dialogs for sending a test email or getting DNS help.
Available
Ports as-is

Examples

Rendered live from the maintained Storybook story. Lantern stores only the story id and embeds Storybook rather than duplicating the component or its demo.

Settings sending domain

Rendered live from Storybook

Storybook must be running for this to load — bun run start:storybook from the monorepo root, or set NEXT_PUBLIC_STORYBOOK_URL to a deployed instance.

Props

The component's public API, read from its TypeScript source. Descriptions come from TSDoc on the prop, so this table cannot drift from the component.

PropTypeDefaultDescription
statusSendingDomainStatus"not_started"Verification status. Drives the pill, the failure banner and the test-email CTA.
senderEmailstring""Sender address shown in the field.
onSenderEmailChange(value: string) => void—Undocumented — add TSDoc to the prop in the library.
onVerify() => void—Fired by "Verify DNS records". Verification itself belongs to the caller.
dnsRecordsSendingDomainDnsRecord[]SENDING_DOMAIN_DNS_RECORDSRecords shown in the expanded table. Defaults to `SENDING_DOMAIN_DNS_RECORDS`.
defaultExpandedbooleanfalseExpands the authentication accordion on mount.
expandedboolean—Controlled expansion. Supply with `onExpandedChange`.
onExpandedChange(expanded: boolean) => void—Undocumented — add TSDoc to the prop in the library.
initialCopiedIndexnumber | nullnullIndex of the DNS row currently showing the "copied" tick. Lifted rather than timed — the source reset it on a 1.5s `setTimeout`, which a story cannot pin.
onCopyRecord(record: SendingDomainDnsRecord, index: number) => void—Undocumented — add TSDoc to the prop in the library.
initialShowRootDomainWarningbooleanfalseShows the root-domain advisory under the sender field.
hasAttemptedVerifybooleanfalseRenders the "changes take up to 48 hours" note under the verify button.
pulseFailedbooleanfalseAdds the attention ring + pulse to the status pill (the post-failure flash).
defaultTestModalOpenbooleanfalseOpens the "Send test email" dialog on mount.
defaultHelpModalOpenbooleanfalseOpens the "Setting up DNS records" dialog on mount.
initialTestEmailstring""Seeds the test-email field.
initialTestSendingbooleanfalseRenders the test dialog's in-flight button label.
initialTestSentbooleanfalseRenders the test dialog's success panel.
initialTestSentTostring""Address echoed in the success panel.
onSendTest(email: string) => void—Undocumented — add TSDoc to the prop in the library.
fallbackSenderstring"spaceid@mail.behindthescenes.com"Fallback sender quoted in the info card.
classNamestring—Undocumented — add TSDoc to the prop in the library.

Reference

Transcribed from the component audit. If this disagrees with the source, the source is right.

Source
src/components/settings/SettingsSendingDomain.tsx
Portability
Copies across unchanged — only the utils import path moves.
Notes
Use when an operator needs to authenticate a custom sending domain; the status pill (not started, pending, verified, failed) gates which actions are available, an apex-domain address triggers a dismissible warning, and a failed verification shows a banner explaining what to do next.