suiss/ui
  • Docs
  • Components
  • Patterns
  • Interactions
  • Charts
  • Blocks
GitHubGet started
DocsComponentsPatternsInteractionsChartsBlocks
Patterns19
  • Overview
  • Action Bar
  • Action Menu
  • App Shell
  • Command Palette
  • Confirm
  • Context Actions
  • Date Picker
  • Flyout
  • Modal
  • Navbar
  • Paged List
  • Panel
  • Picker
  • Preview
  • Search Picker
  • Segment Picker
  • Split View
  • Table List
  • Trail

suiss/ui · Pattern

Preview

A link preview that shows a hover card on desktop and a drawer on mobile.

Preview is an open-source pattern from suiss/ui for React, React Native, SwiftUI and Jetpack Compose. The @esuiss/ui CLI copies its source into your project, so you own the code.

import { CalendarBlankIcon } from "@phosphor-icons/react"
import {
  Preview,
  PreviewContent,
  PreviewTrigger,
} from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"

function ProfileCard() {
  return (
    <div className="flex gap-4">
      <Avatar size="lg">
        <AvatarImage src="https://github.com/vercel.png" alt="@nextjs" />
        <AvatarFallback>NJ</AvatarFallback>
      </Avatar>
      <div className="flex flex-col gap-1">
        <h4 className="text-sm font-semibold">@nextjs</h4>
        <p className="text-sm">
          The React framework, created and maintained by @vercel.
        </p>
        <div className="mt-1 flex items-center gap-1.5 text-xs text-muted-foreground">
          <CalendarBlankIcon />
          Joined December 2021
        </div>
      </div>
    </div>
  )
}

export default function PreviewDemo() {
  return (
    <div className="flex min-h-svh items-center justify-center p-4">
      <Preview>
        <PreviewTrigger href="#">@nextjs</PreviewTrigger>
        <PreviewContent>
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </div>
  )
}

Preview reveals extra information about a link, such as a profile or page summary, without navigating. On desktop it renders a suiss/ui HoverCard that opens when the trigger is hovered or focused. On mobile (below 48rem, via useIsMobile), where hover is not available, it renders a Drawer with a swipe handle that opens when the trigger is tapped. The drawer floats inset from the screen edges by default.

Use it for supplementary content that people can skip. Keep essential information and actions out of the preview, because the hover card opens only on hover or focus.

Installation

CLI

$ pnpm dlx shadcn@latest add @esuiss/preview

Works in any project with a components.json. See Installation for the one-line registry setup. Or use the suiss/ui CLI:

$ pnpm dlx @esuiss/ui@latest add patterns preview

Manual

  1. Add the cn helper.

  2. Add the pieces it builds on: Drawer, Hover Card, use-mobile.

  3. Copy the source into components/patterns/preview.tsx:

components/patterns/preview.tsx
"use client"

import * as React from "react"
import { Drawer, DrawerContent, DrawerTrigger } from "@/components/ui/drawer"
import {
  HoverCard,
  HoverCardContent,
  HoverCardTrigger,
} from "@/components/ui/hover-card"
import { useIsMobile } from "@/hooks/use-mobile"
import { cn } from "@/lib/utils"

type PreviewContextProps = {
  isMobile: boolean
}
  1. Update the import paths to match your project.

Usage

import { Preview, PreviewTrigger, PreviewContent } from "@/components/patterns/preview"
<div className="flex min-h-svh items-center justify-center p-4">
  <Preview>
    <PreviewTrigger href="#">@nextjs</PreviewTrigger>
    <PreviewContent>
      <ProfileCard />
    </PreviewContent>
  </Preview>
</div>
  • Place PreviewTrigger and PreviewContent inside Preview. The parts throw when used outside it.
  • Open state is uncontrolled by default; use defaultOpen, or open with onOpenChange to control it.
  • On desktop the trigger is a link that uses href; on mobile it is a button that opens the drawer, so the link target is not followed.
  • align, alignOffset, side and sideOffset position the desktop card. showCloseButton and closeLabel apply only to the mobile drawer.

Examples

With close button

Adds a close button to the mobile drawer with showCloseButton.

import { CalendarBlankIcon } from "@phosphor-icons/react"
import {
  Preview,
  PreviewContent,
  PreviewTrigger,
} from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"

function ProfileCard() {
  return (
    <div className="flex gap-4">
      <Avatar size="lg">
        <AvatarImage src="https://github.com/vercel.png" alt="@nextjs" />
        <AvatarFallback>NJ</AvatarFallback>
      </Avatar>
      <div className="flex flex-col gap-1">
        <h4 className="text-sm font-semibold">@nextjs</h4>
        <p className="text-sm">
          The React framework, created and maintained by @vercel.
        </p>
        <div className="mt-1 flex items-center gap-1.5 text-xs text-muted-foreground">
          <CalendarBlankIcon />
          Joined December 2021
        </div>
      </div>
    </div>
  )
}

export default function PreviewWithCloseButton() {
  return (
    <div className="flex min-h-svh items-center justify-center p-4">
      <Preview>
        <PreviewTrigger href="#">@nextjs</PreviewTrigger>
        <PreviewContent showCloseButton>
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </div>
  )
}

With close label

Uses a Done text button for the mobile close button through closeLabel.

import { CalendarBlankIcon } from "@phosphor-icons/react"
import {
  Preview,
  PreviewContent,
  PreviewTrigger,
} from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"

function ProfileCard() {
  return (
    <div className="flex gap-4">
      <Avatar size="lg">
        <AvatarImage src="https://github.com/vercel.png" alt="@nextjs" />
        <AvatarFallback>NJ</AvatarFallback>
      </Avatar>
      <div className="flex flex-col gap-1">
        <h4 className="text-sm font-semibold">@nextjs</h4>
        <p className="text-sm">
          The React framework, created and maintained by @vercel.
        </p>
        <div className="mt-1 flex items-center gap-1.5 text-xs text-muted-foreground">
          <CalendarBlankIcon />
          Joined December 2021
        </div>
      </div>
    </div>
  )
}

export default function PreviewWithCloseLabel() {
  return (
    <div className="flex min-h-svh items-center justify-center p-4">
      <Preview>
        <PreviewTrigger href="#">@nextjs</PreviewTrigger>
        <PreviewContent showCloseButton closeLabel="Done">
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </div>
  )
}

Attached

Sets floating to false so the mobile drawer sits on the screen edges.

import { CalendarBlankIcon } from "@phosphor-icons/react"
import {
  Preview,
  PreviewContent,
  PreviewTrigger,
} from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"

function ProfileCard() {
  return (
    <div className="flex gap-4">
      <Avatar size="lg">
        <AvatarImage src="https://github.com/vercel.png" alt="@nextjs" />
        <AvatarFallback>NJ</AvatarFallback>
      </Avatar>
      <div className="flex flex-col gap-1">
        <h4 className="text-sm font-semibold">@nextjs</h4>
        <p className="text-sm">
          The React framework, created and maintained by @vercel.
        </p>
        <div className="mt-1 flex items-center gap-1.5 text-xs text-muted-foreground">
          <CalendarBlankIcon />
          Joined December 2021
        </div>
      </div>
    </div>
  )
}

export default function PreviewAttached() {
  return (
    <div className="flex min-h-svh items-center justify-center p-4">
      <Preview floating={false}>
        <PreviewTrigger href="#">@nextjs</PreviewTrigger>
        <PreviewContent>
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </div>
  )
}

API Reference

Anatomy3 parts
<Preview>
<PreviewTrigger />
<PreviewContent />
</Preview>
01

Preview

The root that chooses HoverCard or Drawer and holds the open state.

PropTypeDefaultDescription
onOpenChange(open: boolean) => void-Called with the new open state when the preview opens or closes.
floatingbooleantrueInsets the mobile drawer from the screen edges. Has no effect on desktop.

Also accepts the props of React.ComponentProps<typeof HoverCard>.

02

PreviewTrigger

The link-styled element that opens the preview.

PropTypeDefaultDescription
hrefstring-The link destination on desktop. Ignored on mobile.

Also accepts the props of React.HTMLAttributes<HTMLElement>.

03

PreviewContent

The card or drawer that holds the preview.

PropTypeDefaultDescription
showCloseButtonboolean-Shows a close button in the mobile drawer.
closeLabelstring-Text for the mobile close button in place of the icon.

Also accepts the props of React.HTMLAttributes<HTMLElement>, React.ComponentProps<typeof HoverCardContent>.

Accessibility

  • On desktop the trigger is a link; the card opens on hover and on keyboard focus, and closes when the pointer leaves.
  • On mobile the trigger is a button that opens the drawer.
  • The trigger shows a focus ring when focused with the keyboard.

Notes

Styling hooks: data-slot="preview", preview-trigger and preview-content. On mobile, className on PreviewContent applies to an inner padded wrapper, which adds end padding to clear the close button when it is shown.

iOS
Preview (open by default) on iOS in light modePreview (open by default) on iOS in dark mode
import { CalendarBlankIcon } from "phosphor-react-native"
import { View } from "react-native"
import { Preview, PreviewContent, PreviewTrigger } from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"
import { Icon } from "@/components/ui/icon"
import { Text } from "@/components/ui/text"

function ProfileCard() {
  return (
    <View className="flex-row gap-4">
      <Avatar size="lg">
        <AvatarImage
          alt="Ada Lovelace"
          source={{ uri: "https://i.pravatar.cc/150?img=5" }}
        />
        <AvatarFallback>AL</AvatarFallback>
      </Avatar>
      <View className="flex-1 gap-1">
        <Text className="text-sm font-semibold">@ada</Text>
        <Text className="text-sm">
          Mathematician and writer, known for her work on the Analytical Engine.
        </Text>
        <View className="mt-1 flex-row items-center gap-1.5">
          <Icon
            as={CalendarBlankIcon}
            className="size-4 text-muted-foreground"
          />
          <Text className="text-xs text-muted-foreground">
            Joined December 2021
          </Text>
        </View>
      </View>
    </View>
  )
}

function PreviewDemo({
  defaultOpen,
  floating,
  showCloseButton,
  closeLabel,
}: {
  defaultOpen?: boolean
  floating?: boolean
  showCloseButton?: boolean
  closeLabel?: string
}) {
  return (
    <View className="flex-1 items-center justify-center">
      <Preview defaultOpen={defaultOpen} floating={floating}>
        <PreviewTrigger>@ada</PreviewTrigger>
        <PreviewContent
          showCloseButton={showCloseButton}
          closeLabel={closeLabel}
          accessibilityLabel="@ada"
        >
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </View>
  )
}

export function PreviewOpenByDefaultExample() {
  return (
    <PreviewDemo defaultOpen />
  )
}
import EsuissUI
import PhosphorSwift
import SwiftUI

struct PreviewOpenByDefaultExample: View {
  var body: some View {
    PreviewDemo(open: true)
  }
}

struct PreviewDemo: View {
  var showCloseButton = false
  var closeLabel: LocalizedStringKey?

  @State private var open: Bool

  init(open: Bool = false, showCloseButton: Bool = false, closeLabel: LocalizedStringKey? = nil) {
    _open = State(initialValue: open)
    self.showCloseButton = showCloseButton
    self.closeLabel = closeLabel
  }

  var body: some View {
    Button {
      open = true
    } label: {
      Text(verbatim: "@ada")
        .textStyle(.base)
        .foregroundStyle(EsuissColor.primary)
    }
    .buttonStyle(PreviewTriggerStyle())
    .preview(isPresented: $open) {
      PreviewContent(showCloseButton: showCloseButton, closeLabel: closeLabel) {
        PreviewProfileCard()
      }
      .accessibilityLabel(Text(verbatim: "@ada"))
    }
    .frame(maxWidth: .infinity)
  }
}

struct PreviewTriggerStyle: ButtonStyle {
  func makeBody(configuration: Configuration) -> some View {
    configuration.label
      .opacity(configuration.isPressed ? 0.8 : 1)
  }
}

struct PreviewProfileCard: View {
  var body: some View {
    HStack(alignment: .top, spacing: 16) {
      Avatar(url: URL(string: "https://i.pravatar.cc/150?img=5"), initials: "AL", size: .lg)
        .accessibilityLabel(Text(verbatim: "Ada Lovelace"))
      VStack(alignment: .leading, spacing: 4) {
        Text(verbatim: "@ada")
          .textStyle(.sm, weight: .semibold)
          .foregroundStyle(EsuissColor.foreground)
        Text("Mathematician and writer, known for her work on the Analytical Engine.")
          .textStyle(.sm)
          .foregroundStyle(EsuissColor.foreground)
          .fixedSize(horizontal: false, vertical: true)
        HStack(spacing: 6) {
          Ph.calendarBlank.regular
            .frame(width: 16, height: 16)
          Text("Joined December 2021")
            .textStyle(.xs)
        }
        .foregroundStyle(EsuissColor.mutedForeground)
        .padding(.top, 4)
      }
      .frame(maxWidth: .infinity, alignment: .leading)
    }
  }
}
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import com.adamglin.PhosphorIcons
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.regular.CalendarBlank
import com.esuiss.ui.components.Avatar
import com.esuiss.ui.components.AvatarFallback
import com.esuiss.ui.components.AvatarSize
import com.esuiss.ui.components.Icon
import com.esuiss.ui.components.Text
import com.esuiss.ui.patterns.Preview
import com.esuiss.ui.patterns.PreviewContent
import com.esuiss.ui.patterns.PreviewTrigger
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Typography

@Composable
fun PreviewOpenByDefaultExample() {
    PreviewDemo(defaultOpen = true)
}

@Composable
fun PreviewProfileCard() {
    val colors = EsuissTheme.colors
    Row(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
        Avatar(size = AvatarSize.Lg, contentDescription = "Ada Lovelace") {
            AvatarFallback("AL")
        }
        Column(Modifier.weight(1f), verticalArrangement = Arrangement.spacedBy(4.dp)) {
            Text("@ada", style = Typography.sm.copy(fontWeight = FontWeight.SemiBold))
            Text(
                "Mathematician and writer, known for her work on the Analytical Engine.",
                style = Typography.sm,
            )
            Row(
                modifier = Modifier.padding(top = 4.dp),
                horizontalArrangement = Arrangement.spacedBy(6.dp),
                verticalAlignment = Alignment.CenterVertically,
            ) {
                Icon(PhosphorIcons.Regular.CalendarBlank, contentDescription = null, size = 16.dp, tint = colors.mutedForeground)
                Text("Joined December 2021", style = Typography.xs.copy(color = colors.mutedForeground))
            }
        }
    }
}

@Composable
fun PreviewDemo(
    defaultOpen: Boolean = false,
    floating: Boolean = true,
    showCloseButton: Boolean = false,
    closeLabel: String? = null,
) {
    var open by rememberSaveable { mutableStateOf(defaultOpen) }
    Box(Modifier.fillMaxWidth(), contentAlignment = Alignment.Center) {
        Preview(open = open, onOpenChange = { open = it }, floating = floating) {
            PreviewTrigger("@ada")
            PreviewContent(
                modifier = Modifier.semantics { contentDescription = "@ada" },
                showCloseButton = showCloseButton,
                closeLabel = closeLabel,
            ) {
                PreviewProfileCard()
            }
        }
    }
}

PreviewTrigger renders inline in the primary color and fades when pressed. It opens a Drawer that floats above the screen edges by default and has a swipe handle.

Use it to show a summary of a person, place or item from a mention or link without leaving the screen.

Installation

$ pnpm dlx shadcn@latest add @esuiss-rn/preview

See Installation for the components.json setup. Or use the suiss/ui CLI:

$ pnpm dlx @esuiss/ui@latest add preview
$ pnpm dlx @esuiss/ui@latest add preview --platform swift
$ pnpm dlx @esuiss/ui@latest add preview --platform kotlin

The CLI also adds what it builds on: Drawer, Text.

Manual

  1. Install the dependencies:
npx expo install cn

  1. Add the pieces it builds on: Drawer, Text, and the primitives components/primitives/use-render.tsx.

  2. Copy the source into components/patterns/preview.tsx:

uniwind/components/patterns/preview.tsx
import { cn } from "cn"
import type * as React from "react"
import { View } from "react-native"
import { resolveClassName } from "@/components/primitives/use-render"
import { Drawer, DrawerContent, DrawerTrigger } from "@/components/ui/drawer"
import { Text, TextClassContext } from "@/components/ui/text"

function Preview({
  open,
  defaultOpen,
  onOpenChange,
  floating = true,
  children,
}: {
  open?: boolean
  defaultOpen?: boolean
  1. Update the import paths to match your project.
  1. Install the dependencies:
npx expo install cn

  1. Add the pieces it builds on: Drawer, Text, and the primitives components/primitives/use-render.tsx.

  2. Copy the source into components/patterns/preview.tsx:

nativewind/components/patterns/preview.tsx
import { cn } from "cn"
import type * as React from "react"
import { View } from "react-native"
import { resolveClassName } from "@/components/primitives/use-render"
import { Drawer, DrawerContent, DrawerTrigger } from "@/components/ui/drawer"
import { Text, TextClassContext } from "@/components/ui/text"

function Preview({
  open,
  defaultOpen,
  onOpenChange,
  floating = true,
  children,
}: {
  open?: boolean
  defaultOpen?: boolean
  1. Update the import paths to match your project.

  1. Add the pieces it builds on: Drawer, Text, and the primitives components/primitives/use-render.tsx.

  2. Copy the source into components/patterns/preview.tsx:

stylesheet/components/patterns/preview.tsx
import type * as React from "react"
import { Pressable, StyleSheet, View, type ViewStyle } from "react-native"
import { resolveStyle } from "@/components/primitives/use-render"
import { Drawer, DrawerContent, DrawerTrigger } from "@/components/ui/drawer"
import { Text, TextStyleContext } from "@/components/ui/text"
import { fontSize, useTheme } from "@/components/ui/theme"

const styles = StyleSheet.create({
  trigger: { alignSelf: "flex-start" },
  pressed: { opacity: 0.6 },
  body: { padding: 16 },
  bodyClose: { paddingEnd: 56 },
  bodyCloseLabel: { paddingEnd: 96 },
})

function Preview({
  1. Update the import paths to match your project.

  1. Target iOS 17 or later.

  2. Add the Swift package to your app:

Package.swift
.package(url: "https://github.com/phosphor-icons/swift", from: "2.1.0")
  1. Copy the theme files every view uses:
swift/Theme/Theme.swift
import SwiftUI
import UIKit

struct RGBA: Sendable {
  let red: CGFloat
  let green: CGFloat
  let blue: CGFloat
  let alpha: CGFloat

  init(_ hex: UInt32, _ alpha: CGFloat = 1) {
    red = CGFloat((hex >> 16) & 0xFF) / 255
    green = CGFloat((hex >> 8) & 0xFF) / 255
    blue = CGFloat(hex & 0xFF) / 255
    self.alpha = alpha
  }
swift/Theme/Tokens.swift
import SwiftUI

public enum EsuissColor {
  public static let background = Color.adaptive(light: .init(0xFFFFFF), dark: .init(0x000000))
  public static let foreground = Color.adaptive(light: .init(0x1D1D1F), dark: .init(0xF5F5F7))
  public static let card = Color.adaptive(light: .init(0xFFFFFF), dark: .init(0x1D1D1F))
  public static let cardForeground = Color.adaptive(light: .init(0x1D1D1F), dark: .init(0xF5F5F7))
  public static let popover = Color.adaptive(light: .init(0xFFFFFF), dark: .init(0x1D1D1F))
  public static let popoverForeground = Color.adaptive(light: .init(0x1D1D1F), dark: .init(0xF5F5F7))
  public static let primary = Color.adaptive(light: .init(0x0071E3), dark: .init(0x2997FF))
  public static let primaryForeground = Color.adaptive(light: .init(0xFFFFFF), dark: .init(0xFFFFFF))
  public static let secondary = Color.adaptive(light: .init(0x000000, 0.04), dark: .init(0xFFFFFF, 0.1))
  public static let secondaryForeground = Color.adaptive(light: .init(0x1D1D1F), dark: .init(0xF5F5F7))
  public static let muted = Color.adaptive(light: .init(0xF5F5F7), dark: .init(0x161617))
  public static let mutedForeground = Color.adaptive(light: .init(0x6E6E73), dark: .init(0xA1A1A6))
  public static let accent = Color.adaptive(light: .init(0x000000, 0.06), dark: .init(0xFFFFFF, 0.1))
  1. Copy the source and every file it uses:
swift/Patterns/Preview.swift
import SwiftUI

extension View {
  public func preview<Content: View>(
    isPresented: Binding<Bool>,
    arrowEdge: Edge = .top,
    @ViewBuilder content: @escaping () -> Content
  ) -> some View {
    modifier(PreviewPresenter(isPresented: isPresented, arrowEdge: arrowEdge, content: content))
  }
}

struct PreviewPresenter<Body: View>: ViewModifier {
  let isPresented: Binding<Bool>
  let arrowEdge: Edge
  @ViewBuilder let content: () -> Body
swift/Components/Button.swift
import SwiftUI

public struct VariantButtonStyle: ButtonStyle {
  public enum Variant: CaseIterable, Sendable {
    case `default`, outline, secondary, tinted, ghost, plain, destructive, link
  }

  public enum Size: CaseIterable, Sendable {
    case `default`, xs, sm, lg, xl, icon, iconXs, iconSm, iconLg, iconXl

    var height: CGFloat {
      switch self {
      case .xs, .iconXs: 24
      case .sm, .iconSm: 32
      case .default, .icon: 36
      case .lg, .iconLg: 44
swift/Components/ButtonGroup.swift
import SwiftUI

extension EnvironmentValues {
  @Entry var buttonGroup: Axis? = nil
  @Entry var buttonGroupSize: CGSize = .zero
}

enum ButtonGroupSpace: Hashable {
  case group
}

struct ButtonGroupFrame {
  let bounds: Anchor<CGRect>
  let outlined: Bool
}
swift/Components/Dialog.swift
import SwiftUI

extension View {
  public func dialog<Content: View>(
    isPresented: Binding<Bool>,
    @ViewBuilder content: @escaping () -> Content
  ) -> some View {
    modifier(
      CoverPresenter(isPresented: isPresented) { visible in
        CenteredStage(visible: visible, dismissible: true, content: content)
      }
    )
  }
}

struct CenteredStage<Content: View>: View {
swift/Components/Drawer.swift
import SwiftUI

extension View {
  public func drawer<Content: View>(
    isPresented: Binding<Bool>,
    detents: Set<PresentationDetent>? = nil,
    selection: Binding<PresentationDetent>? = nil,
    onDismiss: (() -> Void)? = nil,
    @ViewBuilder content: @escaping () -> Content
  ) -> some View {
    let binding = isPresented
    return sheet(isPresented: isPresented, onDismiss: onDismiss) {
      DrawerHost(detents: detents, selection: selection, content: content)
        .environment(\.overlayDismiss, OverlayDismiss { binding.wrappedValue = false })
    }
  }
swift/Components/Overlay.swift
import PhosphorSwift
import Observation
import SwiftUI

public enum PopupAlignment: Sendable, CaseIterable {
  case start, center, end
}

struct OverlayDismiss: Sendable {
  let action: @MainActor @Sendable () -> Void

  @MainActor func callAsFunction() {
    action()
  }
}
swift/Components/Popover.swift
import SwiftUI
import UIKit

public struct PopoverContent<Content: View>: View {
  let width: CGFloat?
  let content: Content

  public init(width: CGFloat? = 288, @ViewBuilder content: () -> Content) {
    self.width = width
    self.content = content()
  }

  public var body: some View {
    VStack(alignment: .leading, spacing: 16) {
      content
    }
swift/Components/TextVariant.swift
import SwiftUI

public enum TextVariant: CaseIterable, Sendable {
  case `default`, h1, h2, h3, h4, p, blockquote, code, lead, large, small, muted

  var style: TextStyle {
    switch self {
    case .h1: .xl3
    case .h2: .xl2
    case .h3: .xl
    case .h4, .lead, .large: .lg
    case .code, .small, .muted: .sm
    default: .base
    }
  }
swift/Patterns/Adaptive.swift
import SwiftUI

extension EnvironmentValues {
  @Entry var patternCompact: Bool? = nil
}

@propertyWrapper
struct CompactLayout: DynamicProperty {
  @Environment(\.patternCompact) private var forced
  @Environment(\.horizontalSizeClass) private var sizeClass

  init() {}

  var wrappedValue: Bool {
    forced ?? (sizeClass != .regular)
  }
  1. Add the files to your app target.
  1. Set minSdk to 24 or higher and add the dependencies:
build.gradle.kts
implementation(platform("androidx.compose:compose-bom:2026.09.00"))
implementation("androidx.compose.foundation:foundation")
implementation("androidx.compose.ui:ui")
implementation("com.adamglin:phosphor-icon-android:1.0.0")
  1. Copy the theme files every view uses:
kotlin/theme/Theme.kt
package com.esuiss.ui.theme

import androidx.compose.foundation.isSystemInDarkTheme
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.Immutable
import androidx.compose.runtime.staticCompositionLocalOf
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.dropShadow
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.Shape
import androidx.compose.ui.graphics.shadow.Shadow as DropShadow
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.style.LineHeightStyle
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.DpOffset
kotlin/theme/Tokens.kt
package com.esuiss.ui.theme

import androidx.compose.runtime.Immutable
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp

@Immutable
data class Colors(
    val background: Color,
    val foreground: Color,
    val card: Color,
    val cardForeground: Color,
    val popover: Color,
    val popoverForeground: Color,
    val primary: Color,
    val primaryForeground: Color,
  1. Copy the source and every file it uses:
kotlin/patterns/Preview.kt
package com.esuiss.ui.patterns

import androidx.compose.foundation.clickable
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.interaction.collectIsPressedAsState
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxScope
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.ColumnScope
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.text.BasicText
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.getValue
import androidx.compose.runtime.remember
kotlin/components/Button.kt
package com.esuiss.ui.components

import androidx.compose.foundation.background
import androidx.compose.foundation.border
import androidx.compose.foundation.clickable
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.interaction.collectIsPressedAsState
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.RowScope
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.foundation.shape.RoundedCornerShape
kotlin/components/ButtonGroup.kt
package com.esuiss.ui.components

import androidx.compose.foundation.background
import androidx.compose.foundation.gestures.Orientation
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.RowScope
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.foundation.shape.CornerSize
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.DisposableEffect
import androidx.compose.runtime.Immutable
kotlin/components/Content.kt
package com.esuiss.ui.components

import androidx.compose.runtime.compositionLocalOf
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp

val LocalContentStyle = compositionLocalOf { TextStyle.Default }

val LocalContentColor = compositionLocalOf { Color.Unspecified }

val LocalIconSize = compositionLocalOf { 20.dp }
kotlin/components/Drawer.kt
package com.esuiss.ui.components

import androidx.compose.animation.core.CubicBezierEasing
import androidx.compose.animation.core.tween
import androidx.compose.foundation.background
import androidx.compose.foundation.gestures.AnchoredDraggableDefaults
import androidx.compose.foundation.gestures.AnchoredDraggableState
import androidx.compose.foundation.gestures.DraggableAnchors
import androidx.compose.foundation.gestures.Orientation
import androidx.compose.foundation.gestures.anchoredDraggable
import androidx.compose.foundation.gestures.animateTo
import androidx.compose.foundation.gestures.detectTapGestures
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.Column
kotlin/components/Icon.kt
package com.esuiss.ui.components

import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.size
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.ColorFilter
import androidx.compose.ui.graphics.takeOrElse
import androidx.compose.ui.graphics.vector.ImageVector
import androidx.compose.ui.unit.Dp
import com.esuiss.ui.theme.EsuissTheme

@Composable
fun Icon(
    imageVector: ImageVector,
kotlin/components/Overlay.kt
package com.esuiss.ui.components

import android.os.Build
import android.view.Window
import android.view.WindowManager
import androidx.compose.animation.AnimatedVisibility
import androidx.compose.animation.AnimatedVisibilityScope
import androidx.compose.animation.EnterExitState
import androidx.compose.animation.core.MutableTransitionState
import androidx.compose.animation.core.animateFloat
import androidx.compose.animation.core.tween
import androidx.compose.animation.fadeIn
import androidx.compose.animation.fadeOut
import androidx.compose.animation.scaleIn
import androidx.compose.animation.scaleOut
import androidx.compose.animation.slideIn
kotlin/patterns/DrawerPatterns.kt
package com.esuiss.ui.patterns

import androidx.compose.foundation.layout.ColumnScope
import androidx.compose.runtime.Composable
import androidx.compose.runtime.Immutable
import androidx.compose.runtime.ProvidableCompositionLocal
import androidx.compose.runtime.staticCompositionLocalOf
import androidx.compose.ui.Modifier
import com.esuiss.ui.components.Drawer

@Immutable
internal class DrawerPatternState(
    val open: Boolean,
    val onOpenChange: (Boolean) -> Unit,
    val floating: Boolean,
)
  1. Update the com.esuiss.ui package names to match your project.

Usage

import { Preview, PreviewTrigger, PreviewContent } from "@/components/patterns/preview"
<PreviewDemo defaultOpen />

Put a PreviewTrigger and a PreviewContent inside Preview. A string or number child of the trigger is wrapped in Text.

The preview can be uncontrolled or controlled with open, defaultOpen and onOpenChange. PreviewContent pads its children and adds end padding when a close button is shown, so content does not sit under it.

Examples

Default

iOS
Preview on iOS in light modePreview on iOS in dark mode
import { CalendarBlankIcon } from "phosphor-react-native"
import { View } from "react-native"
import { Preview, PreviewContent, PreviewTrigger } from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"
import { Icon } from "@/components/ui/icon"
import { Text } from "@/components/ui/text"

function ProfileCard() {
  return (
    <View className="flex-row gap-4">
      <Avatar size="lg">
        <AvatarImage
          alt="Ada Lovelace"
          source={{ uri: "https://i.pravatar.cc/150?img=5" }}
        />
        <AvatarFallback>AL</AvatarFallback>
      </Avatar>
      <View className="flex-1 gap-1">
        <Text className="text-sm font-semibold">@ada</Text>
        <Text className="text-sm">
          Mathematician and writer, known for her work on the Analytical Engine.
        </Text>
        <View className="mt-1 flex-row items-center gap-1.5">
          <Icon
            as={CalendarBlankIcon}
            className="size-4 text-muted-foreground"
          />
          <Text className="text-xs text-muted-foreground">
            Joined December 2021
          </Text>
        </View>
      </View>
    </View>
  )
}

function PreviewDemo({
  defaultOpen,
  floating,
  showCloseButton,
  closeLabel,
}: {
  defaultOpen?: boolean
  floating?: boolean
  showCloseButton?: boolean
  closeLabel?: string
}) {
  return (
    <View className="flex-1 items-center justify-center">
      <Preview defaultOpen={defaultOpen} floating={floating}>
        <PreviewTrigger>@ada</PreviewTrigger>
        <PreviewContent
          showCloseButton={showCloseButton}
          closeLabel={closeLabel}
          accessibilityLabel="@ada"
        >
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </View>
  )
}

export function PreviewExample() {
  return (
    <PreviewDemo />
  )
}
import EsuissUI
import PhosphorSwift
import SwiftUI

struct PreviewDemo: View {
  var showCloseButton = false
  var closeLabel: LocalizedStringKey?

  @State private var open: Bool

  init(open: Bool = false, showCloseButton: Bool = false, closeLabel: LocalizedStringKey? = nil) {
    _open = State(initialValue: open)
    self.showCloseButton = showCloseButton
    self.closeLabel = closeLabel
  }

  var body: some View {
    Button {
      open = true
    } label: {
      Text(verbatim: "@ada")
        .textStyle(.base)
        .foregroundStyle(EsuissColor.primary)
    }
    .buttonStyle(PreviewTriggerStyle())
    .preview(isPresented: $open) {
      PreviewContent(showCloseButton: showCloseButton, closeLabel: closeLabel) {
        PreviewProfileCard()
      }
      .accessibilityLabel(Text(verbatim: "@ada"))
    }
    .frame(maxWidth: .infinity)
  }
}

struct PreviewTriggerStyle: ButtonStyle {
  func makeBody(configuration: Configuration) -> some View {
    configuration.label
      .opacity(configuration.isPressed ? 0.8 : 1)
  }
}

struct PreviewProfileCard: View {
  var body: some View {
    HStack(alignment: .top, spacing: 16) {
      Avatar(url: URL(string: "https://i.pravatar.cc/150?img=5"), initials: "AL", size: .lg)
        .accessibilityLabel(Text(verbatim: "Ada Lovelace"))
      VStack(alignment: .leading, spacing: 4) {
        Text(verbatim: "@ada")
          .textStyle(.sm, weight: .semibold)
          .foregroundStyle(EsuissColor.foreground)
        Text("Mathematician and writer, known for her work on the Analytical Engine.")
          .textStyle(.sm)
          .foregroundStyle(EsuissColor.foreground)
          .fixedSize(horizontal: false, vertical: true)
        HStack(spacing: 6) {
          Ph.calendarBlank.regular
            .frame(width: 16, height: 16)
          Text("Joined December 2021")
            .textStyle(.xs)
        }
        .foregroundStyle(EsuissColor.mutedForeground)
        .padding(.top, 4)
      }
      .frame(maxWidth: .infinity, alignment: .leading)
    }
  }
}
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import com.adamglin.PhosphorIcons
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.regular.CalendarBlank
import com.esuiss.ui.components.Avatar
import com.esuiss.ui.components.AvatarFallback
import com.esuiss.ui.components.AvatarSize
import com.esuiss.ui.components.Icon
import com.esuiss.ui.components.Text
import com.esuiss.ui.patterns.Preview
import com.esuiss.ui.patterns.PreviewContent
import com.esuiss.ui.patterns.PreviewTrigger
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Typography

@Composable
fun PreviewProfileCard() {
    val colors = EsuissTheme.colors
    Row(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
        Avatar(size = AvatarSize.Lg, contentDescription = "Ada Lovelace") {
            AvatarFallback("AL")
        }
        Column(Modifier.weight(1f), verticalArrangement = Arrangement.spacedBy(4.dp)) {
            Text("@ada", style = Typography.sm.copy(fontWeight = FontWeight.SemiBold))
            Text(
                "Mathematician and writer, known for her work on the Analytical Engine.",
                style = Typography.sm,
            )
            Row(
                modifier = Modifier.padding(top = 4.dp),
                horizontalArrangement = Arrangement.spacedBy(6.dp),
                verticalAlignment = Alignment.CenterVertically,
            ) {
                Icon(PhosphorIcons.Regular.CalendarBlank, contentDescription = null, size = 16.dp, tint = colors.mutedForeground)
                Text("Joined December 2021", style = Typography.xs.copy(color = colors.mutedForeground))
            }
        }
    }
}

@Composable
fun PreviewDemo(
    defaultOpen: Boolean = false,
    floating: Boolean = true,
    showCloseButton: Boolean = false,
    closeLabel: String? = null,
) {
    var open by rememberSaveable { mutableStateOf(defaultOpen) }
    Box(Modifier.fillMaxWidth(), contentAlignment = Alignment.Center) {
        Preview(open = open, onOpenChange = { open = it }, floating = floating) {
            PreviewTrigger("@ada")
            PreviewContent(
                modifier = Modifier.semantics { contentDescription = "@ada" },
                showCloseButton = showCloseButton,
                closeLabel = closeLabel,
            ) {
                PreviewProfileCard()
            }
        }
    }
}

With close button

Shows a close button with showCloseButton.

iOS
Preview (with close button) on iOS in light modePreview (with close button) on iOS in dark mode
import { CalendarBlankIcon } from "phosphor-react-native"
import { View } from "react-native"
import { Preview, PreviewContent, PreviewTrigger } from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"
import { Icon } from "@/components/ui/icon"
import { Text } from "@/components/ui/text"

function ProfileCard() {
  return (
    <View className="flex-row gap-4">
      <Avatar size="lg">
        <AvatarImage
          alt="Ada Lovelace"
          source={{ uri: "https://i.pravatar.cc/150?img=5" }}
        />
        <AvatarFallback>AL</AvatarFallback>
      </Avatar>
      <View className="flex-1 gap-1">
        <Text className="text-sm font-semibold">@ada</Text>
        <Text className="text-sm">
          Mathematician and writer, known for her work on the Analytical Engine.
        </Text>
        <View className="mt-1 flex-row items-center gap-1.5">
          <Icon
            as={CalendarBlankIcon}
            className="size-4 text-muted-foreground"
          />
          <Text className="text-xs text-muted-foreground">
            Joined December 2021
          </Text>
        </View>
      </View>
    </View>
  )
}

function PreviewDemo({
  defaultOpen,
  floating,
  showCloseButton,
  closeLabel,
}: {
  defaultOpen?: boolean
  floating?: boolean
  showCloseButton?: boolean
  closeLabel?: string
}) {
  return (
    <View className="flex-1 items-center justify-center">
      <Preview defaultOpen={defaultOpen} floating={floating}>
        <PreviewTrigger>@ada</PreviewTrigger>
        <PreviewContent
          showCloseButton={showCloseButton}
          closeLabel={closeLabel}
          accessibilityLabel="@ada"
        >
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </View>
  )
}

export function PreviewWithCloseButtonExample() {
  return (
    <PreviewDemo defaultOpen showCloseButton />
  )
}
import EsuissUI
import PhosphorSwift
import SwiftUI

struct PreviewWithCloseButtonExample: View {
  var body: some View {
    PreviewDemo(open: true, showCloseButton: true)
  }
}

struct PreviewDemo: View {
  var showCloseButton = false
  var closeLabel: LocalizedStringKey?

  @State private var open: Bool

  init(open: Bool = false, showCloseButton: Bool = false, closeLabel: LocalizedStringKey? = nil) {
    _open = State(initialValue: open)
    self.showCloseButton = showCloseButton
    self.closeLabel = closeLabel
  }

  var body: some View {
    Button {
      open = true
    } label: {
      Text(verbatim: "@ada")
        .textStyle(.base)
        .foregroundStyle(EsuissColor.primary)
    }
    .buttonStyle(PreviewTriggerStyle())
    .preview(isPresented: $open) {
      PreviewContent(showCloseButton: showCloseButton, closeLabel: closeLabel) {
        PreviewProfileCard()
      }
      .accessibilityLabel(Text(verbatim: "@ada"))
    }
    .frame(maxWidth: .infinity)
  }
}

struct PreviewTriggerStyle: ButtonStyle {
  func makeBody(configuration: Configuration) -> some View {
    configuration.label
      .opacity(configuration.isPressed ? 0.8 : 1)
  }
}

struct PreviewProfileCard: View {
  var body: some View {
    HStack(alignment: .top, spacing: 16) {
      Avatar(url: URL(string: "https://i.pravatar.cc/150?img=5"), initials: "AL", size: .lg)
        .accessibilityLabel(Text(verbatim: "Ada Lovelace"))
      VStack(alignment: .leading, spacing: 4) {
        Text(verbatim: "@ada")
          .textStyle(.sm, weight: .semibold)
          .foregroundStyle(EsuissColor.foreground)
        Text("Mathematician and writer, known for her work on the Analytical Engine.")
          .textStyle(.sm)
          .foregroundStyle(EsuissColor.foreground)
          .fixedSize(horizontal: false, vertical: true)
        HStack(spacing: 6) {
          Ph.calendarBlank.regular
            .frame(width: 16, height: 16)
          Text("Joined December 2021")
            .textStyle(.xs)
        }
        .foregroundStyle(EsuissColor.mutedForeground)
        .padding(.top, 4)
      }
      .frame(maxWidth: .infinity, alignment: .leading)
    }
  }
}
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import com.adamglin.PhosphorIcons
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.regular.CalendarBlank
import com.esuiss.ui.components.Avatar
import com.esuiss.ui.components.AvatarFallback
import com.esuiss.ui.components.AvatarSize
import com.esuiss.ui.components.Icon
import com.esuiss.ui.components.Text
import com.esuiss.ui.patterns.Preview
import com.esuiss.ui.patterns.PreviewContent
import com.esuiss.ui.patterns.PreviewTrigger
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Typography

@Composable
fun PreviewWithCloseButtonExample() {
    PreviewDemo(defaultOpen = true, showCloseButton = true)
}

@Composable
fun PreviewProfileCard() {
    val colors = EsuissTheme.colors
    Row(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
        Avatar(size = AvatarSize.Lg, contentDescription = "Ada Lovelace") {
            AvatarFallback("AL")
        }
        Column(Modifier.weight(1f), verticalArrangement = Arrangement.spacedBy(4.dp)) {
            Text("@ada", style = Typography.sm.copy(fontWeight = FontWeight.SemiBold))
            Text(
                "Mathematician and writer, known for her work on the Analytical Engine.",
                style = Typography.sm,
            )
            Row(
                modifier = Modifier.padding(top = 4.dp),
                horizontalArrangement = Arrangement.spacedBy(6.dp),
                verticalAlignment = Alignment.CenterVertically,
            ) {
                Icon(PhosphorIcons.Regular.CalendarBlank, contentDescription = null, size = 16.dp, tint = colors.mutedForeground)
                Text("Joined December 2021", style = Typography.xs.copy(color = colors.mutedForeground))
            }
        }
    }
}

@Composable
fun PreviewDemo(
    defaultOpen: Boolean = false,
    floating: Boolean = true,
    showCloseButton: Boolean = false,
    closeLabel: String? = null,
) {
    var open by rememberSaveable { mutableStateOf(defaultOpen) }
    Box(Modifier.fillMaxWidth(), contentAlignment = Alignment.Center) {
        Preview(open = open, onOpenChange = { open = it }, floating = floating) {
            PreviewTrigger("@ada")
            PreviewContent(
                modifier = Modifier.semantics { contentDescription = "@ada" },
                showCloseButton = showCloseButton,
                closeLabel = closeLabel,
            ) {
                PreviewProfileCard()
            }
        }
    }
}

With close label

Labels the close button Done with closeLabel.

iOS
Preview (with close label) on iOS in light modePreview (with close label) on iOS in dark mode
import { CalendarBlankIcon } from "phosphor-react-native"
import { View } from "react-native"
import { Preview, PreviewContent, PreviewTrigger } from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"
import { Icon } from "@/components/ui/icon"
import { Text } from "@/components/ui/text"

function ProfileCard() {
  return (
    <View className="flex-row gap-4">
      <Avatar size="lg">
        <AvatarImage
          alt="Ada Lovelace"
          source={{ uri: "https://i.pravatar.cc/150?img=5" }}
        />
        <AvatarFallback>AL</AvatarFallback>
      </Avatar>
      <View className="flex-1 gap-1">
        <Text className="text-sm font-semibold">@ada</Text>
        <Text className="text-sm">
          Mathematician and writer, known for her work on the Analytical Engine.
        </Text>
        <View className="mt-1 flex-row items-center gap-1.5">
          <Icon
            as={CalendarBlankIcon}
            className="size-4 text-muted-foreground"
          />
          <Text className="text-xs text-muted-foreground">
            Joined December 2021
          </Text>
        </View>
      </View>
    </View>
  )
}

function PreviewDemo({
  defaultOpen,
  floating,
  showCloseButton,
  closeLabel,
}: {
  defaultOpen?: boolean
  floating?: boolean
  showCloseButton?: boolean
  closeLabel?: string
}) {
  return (
    <View className="flex-1 items-center justify-center">
      <Preview defaultOpen={defaultOpen} floating={floating}>
        <PreviewTrigger>@ada</PreviewTrigger>
        <PreviewContent
          showCloseButton={showCloseButton}
          closeLabel={closeLabel}
          accessibilityLabel="@ada"
        >
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </View>
  )
}

export function PreviewWithCloseLabelExample() {
  return (
    <PreviewDemo defaultOpen showCloseButton closeLabel="Done" />
  )
}
import EsuissUI
import PhosphorSwift
import SwiftUI

struct PreviewWithCloseLabelExample: View {
  var body: some View {
    PreviewDemo(open: true, showCloseButton: true, closeLabel: "Done")
  }
}

struct PreviewDemo: View {
  var showCloseButton = false
  var closeLabel: LocalizedStringKey?

  @State private var open: Bool

  init(open: Bool = false, showCloseButton: Bool = false, closeLabel: LocalizedStringKey? = nil) {
    _open = State(initialValue: open)
    self.showCloseButton = showCloseButton
    self.closeLabel = closeLabel
  }

  var body: some View {
    Button {
      open = true
    } label: {
      Text(verbatim: "@ada")
        .textStyle(.base)
        .foregroundStyle(EsuissColor.primary)
    }
    .buttonStyle(PreviewTriggerStyle())
    .preview(isPresented: $open) {
      PreviewContent(showCloseButton: showCloseButton, closeLabel: closeLabel) {
        PreviewProfileCard()
      }
      .accessibilityLabel(Text(verbatim: "@ada"))
    }
    .frame(maxWidth: .infinity)
  }
}

struct PreviewTriggerStyle: ButtonStyle {
  func makeBody(configuration: Configuration) -> some View {
    configuration.label
      .opacity(configuration.isPressed ? 0.8 : 1)
  }
}

struct PreviewProfileCard: View {
  var body: some View {
    HStack(alignment: .top, spacing: 16) {
      Avatar(url: URL(string: "https://i.pravatar.cc/150?img=5"), initials: "AL", size: .lg)
        .accessibilityLabel(Text(verbatim: "Ada Lovelace"))
      VStack(alignment: .leading, spacing: 4) {
        Text(verbatim: "@ada")
          .textStyle(.sm, weight: .semibold)
          .foregroundStyle(EsuissColor.foreground)
        Text("Mathematician and writer, known for her work on the Analytical Engine.")
          .textStyle(.sm)
          .foregroundStyle(EsuissColor.foreground)
          .fixedSize(horizontal: false, vertical: true)
        HStack(spacing: 6) {
          Ph.calendarBlank.regular
            .frame(width: 16, height: 16)
          Text("Joined December 2021")
            .textStyle(.xs)
        }
        .foregroundStyle(EsuissColor.mutedForeground)
        .padding(.top, 4)
      }
      .frame(maxWidth: .infinity, alignment: .leading)
    }
  }
}
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import com.adamglin.PhosphorIcons
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.regular.CalendarBlank
import com.esuiss.ui.components.Avatar
import com.esuiss.ui.components.AvatarFallback
import com.esuiss.ui.components.AvatarSize
import com.esuiss.ui.components.Icon
import com.esuiss.ui.components.Text
import com.esuiss.ui.patterns.Preview
import com.esuiss.ui.patterns.PreviewContent
import com.esuiss.ui.patterns.PreviewTrigger
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Typography

@Composable
fun PreviewWithCloseLabelExample() {
    PreviewDemo(defaultOpen = true, showCloseButton = true, closeLabel = "Done")
}

@Composable
fun PreviewProfileCard() {
    val colors = EsuissTheme.colors
    Row(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
        Avatar(size = AvatarSize.Lg, contentDescription = "Ada Lovelace") {
            AvatarFallback("AL")
        }
        Column(Modifier.weight(1f), verticalArrangement = Arrangement.spacedBy(4.dp)) {
            Text("@ada", style = Typography.sm.copy(fontWeight = FontWeight.SemiBold))
            Text(
                "Mathematician and writer, known for her work on the Analytical Engine.",
                style = Typography.sm,
            )
            Row(
                modifier = Modifier.padding(top = 4.dp),
                horizontalArrangement = Arrangement.spacedBy(6.dp),
                verticalAlignment = Alignment.CenterVertically,
            ) {
                Icon(PhosphorIcons.Regular.CalendarBlank, contentDescription = null, size = 16.dp, tint = colors.mutedForeground)
                Text("Joined December 2021", style = Typography.xs.copy(color = colors.mutedForeground))
            }
        }
    }
}

@Composable
fun PreviewDemo(
    defaultOpen: Boolean = false,
    floating: Boolean = true,
    showCloseButton: Boolean = false,
    closeLabel: String? = null,
) {
    var open by rememberSaveable { mutableStateOf(defaultOpen) }
    Box(Modifier.fillMaxWidth(), contentAlignment = Alignment.Center) {
        Preview(open = open, onOpenChange = { open = it }, floating = floating) {
            PreviewTrigger("@ada")
            PreviewContent(
                modifier = Modifier.semantics { contentDescription = "@ada" },
                showCloseButton = showCloseButton,
                closeLabel = closeLabel,
            ) {
                PreviewProfileCard()
            }
        }
    }
}

Attached

Sets floating to false so the drawer sits on the screen edges.

iOS
Preview (attached) on iOS in light modePreview (attached) on iOS in dark mode
import { CalendarBlankIcon } from "phosphor-react-native"
import { View } from "react-native"
import { Preview, PreviewContent, PreviewTrigger } from "@/components/patterns/preview"
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar"
import { Icon } from "@/components/ui/icon"
import { Text } from "@/components/ui/text"

function ProfileCard() {
  return (
    <View className="flex-row gap-4">
      <Avatar size="lg">
        <AvatarImage
          alt="Ada Lovelace"
          source={{ uri: "https://i.pravatar.cc/150?img=5" }}
        />
        <AvatarFallback>AL</AvatarFallback>
      </Avatar>
      <View className="flex-1 gap-1">
        <Text className="text-sm font-semibold">@ada</Text>
        <Text className="text-sm">
          Mathematician and writer, known for her work on the Analytical Engine.
        </Text>
        <View className="mt-1 flex-row items-center gap-1.5">
          <Icon
            as={CalendarBlankIcon}
            className="size-4 text-muted-foreground"
          />
          <Text className="text-xs text-muted-foreground">
            Joined December 2021
          </Text>
        </View>
      </View>
    </View>
  )
}

function PreviewDemo({
  defaultOpen,
  floating,
  showCloseButton,
  closeLabel,
}: {
  defaultOpen?: boolean
  floating?: boolean
  showCloseButton?: boolean
  closeLabel?: string
}) {
  return (
    <View className="flex-1 items-center justify-center">
      <Preview defaultOpen={defaultOpen} floating={floating}>
        <PreviewTrigger>@ada</PreviewTrigger>
        <PreviewContent
          showCloseButton={showCloseButton}
          closeLabel={closeLabel}
          accessibilityLabel="@ada"
        >
          <ProfileCard />
        </PreviewContent>
      </Preview>
    </View>
  )
}

export function PreviewAttachedExample() {
  return (
    <PreviewDemo defaultOpen floating={false} />
  )
}
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import com.adamglin.PhosphorIcons
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.regular.CalendarBlank
import com.esuiss.ui.components.Avatar
import com.esuiss.ui.components.AvatarFallback
import com.esuiss.ui.components.AvatarSize
import com.esuiss.ui.components.Icon
import com.esuiss.ui.components.Text
import com.esuiss.ui.patterns.Preview
import com.esuiss.ui.patterns.PreviewContent
import com.esuiss.ui.patterns.PreviewTrigger
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Typography

@Composable
fun PreviewAttachedExample() {
    PreviewDemo(defaultOpen = true, floating = false)
}

@Composable
fun PreviewProfileCard() {
    val colors = EsuissTheme.colors
    Row(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
        Avatar(size = AvatarSize.Lg, contentDescription = "Ada Lovelace") {
            AvatarFallback("AL")
        }
        Column(Modifier.weight(1f), verticalArrangement = Arrangement.spacedBy(4.dp)) {
            Text("@ada", style = Typography.sm.copy(fontWeight = FontWeight.SemiBold))
            Text(
                "Mathematician and writer, known for her work on the Analytical Engine.",
                style = Typography.sm,
            )
            Row(
                modifier = Modifier.padding(top = 4.dp),
                horizontalArrangement = Arrangement.spacedBy(6.dp),
                verticalAlignment = Alignment.CenterVertically,
            ) {
                Icon(PhosphorIcons.Regular.CalendarBlank, contentDescription = null, size = 16.dp, tint = colors.mutedForeground)
                Text("Joined December 2021", style = Typography.xs.copy(color = colors.mutedForeground))
            }
        }
    }
}

@Composable
fun PreviewDemo(
    defaultOpen: Boolean = false,
    floating: Boolean = true,
    showCloseButton: Boolean = false,
    closeLabel: String? = null,
) {
    var open by rememberSaveable { mutableStateOf(defaultOpen) }
    Box(Modifier.fillMaxWidth(), contentAlignment = Alignment.Center) {
        Preview(open = open, onOpenChange = { open = it }, floating = floating) {
            PreviewTrigger("@ada")
            PreviewContent(
                modifier = Modifier.semantics { contentDescription = "@ada" },
                showCloseButton = showCloseButton,
                closeLabel = closeLabel,
            ) {
                PreviewProfileCard()
            }
        }
    }
}

API Reference

01

Preview

The root drawer, floating by default.

PropTypeDefaultDescription
openboolean-Controls whether the preview is open.
defaultOpenboolean-Whether the preview starts open when uncontrolled.
onOpenChange(open: boolean) => void-Called when the preview opens or closes.
floatingbooleantrueInsets the drawer from the screen edges. Defaults to true.
childrenReact.ReactNode-
02

PreviewTrigger

The link-styled element that opens the preview.

Also accepts the props of React.ComponentProps<typeof DrawerTrigger>.

03

PreviewContent

The drawer content with padding for the preview.

PropTypeDefaultDescription
classNamestring-

Also accepts the props of React.ComponentProps<typeof DrawerContent>.

Accessibility

  • Give PreviewContent an accessibilityLabel that names what is previewed.

Notes

  • The trigger uses the text-primary color.
NextSearch PickerPreviousPicker

On this page

  1. 01Installation
    • CLI
    • Manual
  2. 02Usage
  3. 03Examples
    • With close button
    • With close label
    • Attached
  4. 04API Reference
    • Preview
    • PreviewTrigger
    • PreviewContent
  5. 05Accessibility
  6. 06Notes
  7. 07Installation
    • Manual
  8. 08Usage
  9. 09Examples
    • Default
    • With close button
    • With close label
    • Attached
  10. 10API Reference
    • Preview
    • PreviewTrigger
    • PreviewContent
  11. 11Accessibility
  12. 12Notes