Site color

Choose your site’s color palette.

Saved on this device.

SignIn

SignInAccount entry

An account-menu entry point with signed-in and signed-out presentation, optional avatars and replaceable destinations.

Site navigation & services

An account menu with custom destinations

The isolated preview enables the account component locally and uses working documentation links in its default slot.

SignIn in contextCOMPOSITION

Signed-out and signed-in states, avatars, sign-up, and custom destinations. Open the source tab to adapt the composition.

---
template: preview
index: false
title: sign-in preview
---

<Flex align="center" justify="between">
  <span>Example workspace</span>
  <SignIn
    :enabled="true"
    :signUp="false"
    label="Workspace account"
    tone="neutral"
  >
    <Flex
      container="nav"
      direction="column"
      aria-label="Example account destinations"
    >
      <BtnLink href="/components/" variant="subtleBtn"
        >Component library</BtnLink>
      <BtnLink href="/components/site/site-logo/" variant="subtleBtn">
        Workspace branding
      </BtnLink>
    </Flex>
  </SignIn>
</Flex>
<p class="mt-4">
  Open the account menu. These custom destinations are documentation links; this
  preview does not sign you in.
</p>

All ten semantic tones

All supported values are visible together on the actual component, in an isolated document.

All ten semantic tonesCOMPOSITION

Samples follow this guide’s theme. Service appearance comparisons do not register account, search, or consent services.

All eighteen visual variants

All supported values are visible together on the actual component, in an isolated document.

All eighteen visual variantsCOMPOSITION

Samples follow this guide’s theme. Service appearance comparisons do not register account, search, or consent services.

Both variant modes

Compare stateless and stateful outlineFill treatments. Hover the samples; a stateful surface does not create new application behavior.

Both variant modesCOMPOSITION

Samples follow this guide’s theme. Service appearance comparisons do not register account, search, or consent services.

Feature comparisons

Every configuration in viewCOMPOSITION

Each labelled sample exposes a different public feature or site configuration. Account states are presentation examples.

Account state and content slots

The comparisons show signed-out menus with and without sign-up, signed-in menus with a default icon or image avatar, custom icons and an avatar slot, and auth disabled. These are explicit component states for presentation; they do not create a session. The original working preview has real documentation links in its default slot.

The label prop supplies hidden trigger text; the trigger currently retains the fixed accessible label Account menu. avatarAlt applies to the image. The avatar slot takes precedence over the avatar image and accountIcon.

Feature map

Feature Where to explore it
Signed-out and signed-in states, avatars, sign-up, and custom destinations Context preview, feature comparisons, and original copyable source examples.
Public appearance options Complete galleries above. Only options supported by this component are shown.
Native semantics and integration Behavior notes and API contracts below explain the component’s roots, slots, and runtime dependencies.

Behavior and accessibility

The component defaults to site.auth.enabled; the enabled prop overrides it for an instance. The signUp prop overrides site.auth.signUp, and signedIn selects a static presentation without creating a session. It does not authenticate users itself. The standard auth-state hint controls signed-in versus signed-out presentation; the server remains responsible for session authorization. The native summary opens with Enter or Space, and the menu runtime handles Escape and outside clicks.

API reference

SignIn contract

Props below are the public template API. RefOrValue accepts a literal or a reactive ref; bind refs with a colon-prefixed attribute. Native attributes and events can be passed through the component root.

avatarSrc

RefOrValue<string>
Default
not set

Signed-in avatar URL. With no avatar, accountIcon is used.

avatarAlt

RefOrValue<string>
Default
empty string

Avatar image alternative text. Decorative account imagery can keep the empty default.

icon

RefOrValue<string>
Default
lucide:log-in

Signed-out trigger icon.

accountIcon

RefOrValue<string>
Default
tabler:user-filled

Signed-in fallback icon.

label

RefOrValue<string>
Default
Account

Hidden trigger text. The summary currently has the fixed accessible label Account menu.

tone

RefOrValue<SemanticTone>
Default
inherited

Semantic intent: neutral, accent, secondary, info, success, warning, danger, feature, custom or ghost. The active skin supplies the colors.

variant

RefOrValue<ComponentVariant>
Default
surfaceAlt

Account menu panel treatment.

variantMode

RefOrValue<ComponentVariantMode>
Default
stateless

Use stateless for content surfaces; stateful enables the treatment’s hover, focus and active styles. It does not add interaction handlers.

enabled

RefOrValue<boolean>
Default
site.auth.enabled

Overrides authentication UI visibility for this instance.

signUp

RefOrValue<boolean>
Default
site.auth.signUp

Overrides visibility of the default sign-up action.

signedIn

RefOrValue<boolean>
Default
runtime auth state

Selects signed-in or signed-out presentation for this instance. Omit it to follow the runtime auth hint. This prop does not authenticate a session.

Composition

avatar: custom signed-in trigger content. default slot: replaces the generated account links. Default routes are /signin/, /signup/, /account/, /account/settings/ and /signout/. Register defineSignInComponents with Panel, Flex, BtnLink and Icon.