Skip to content
rw3iss Auth

ProviderBranding

atom @rw3iss/auth-client/preact/atoms/ProviderBranding framework-adapters/preact/components/atoms/ProviderBranding.tsx ↗

The provider’s mark — icon above/beside its name. Used at the top of and so a user handing over a password can see WHO they’re handing it to (that is the whole point of branding an auth form; it isn’t decoration).

Renders NOTHING when there is neither an icon nor a name — a header that reserves space for an identity we failed to resolve just pushes the form down for no reason.

Usage

import { ProviderBranding } from '@rw3iss/auth-client/preact/atoms';
<ProviderBranding />

Props

NameTypeDescription
providerProviderIdentity | nullHost-supplied identity — skips the fetch entirely.
clientAuthClient
size'sm' | 'md' | 'lg'
showNamebooleanPrint the provider name under/next to the icon. Default true.
shortNamebooleanUse the abbreviated name when the server published one.
taglineComponentChildrenOptional line under the name, e.g. “Sign in to continue”.
layout'stacked' | 'inline'Stack the icon over the name (default) or sit them side by side.
as'span' | 'h1' | 'h2' | 'h3'Element for the name. Default `span` — a form header is rarely the page’s heading, so opt in explicitly.
classNamestring