# Aspect Ratio

A container that keeps its content at a fixed width-to-height ratio.

Aspect Ratio is an open-source component 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.

Source: https://ui.suiss.app/docs/components/aspect-ratio

**React**

**Example**

```tsx
import { AspectRatio } from "@/components/ui/aspect-ratio"

export default function AspectRatioDemo() {
  return (
    <div className="w-96">
      <AspectRatio
        ratio={16 / 9}
        className="overflow-hidden rounded-2xl bg-muted"
      >
        <img
          src="https://images.unsplash.com/photo-1506744038136-46273834b3fb?w=800&q=80"
          alt="Mountain lake at sunrise"
          className="size-full object-cover"
        />
      </AspectRatio>
    </div>
  )
}
```

`AspectRatio` is a single `div` that sets the CSS `aspect-ratio` property from the `ratio` prop. Its width follows the parent, and its height is derived from the ratio. It is positioned `relative`, so children can be absolutely positioned inside it.

Use it to reserve space for images, video or embeds so the layout does not shift while media loads.

## Installation

### CLI

```bash title="Terminal"
npx shadcn@latest add @esuiss/aspect-ratio
```

Works in any project with a `components.json`. See [Installation](https://ui.suiss.app/docs/installation#add-components) for the one-line registry setup. Or use the suiss/ui CLI:

```bash title="Terminal"
npx @esuiss/ui@latest add aspect-ratio
```

### Manual

1. Add the [`cn` helper](https://ui.suiss.app/docs/installation#the-cn-helper).

2. Copy the source into `components/ui/aspect-ratio.tsx`:

```tsx title="components/ui/aspect-ratio.tsx"
import { cn } from "@/lib/utils"

function AspectRatio({
  ratio,
  className,
  ...props
}: React.ComponentProps<"div"> & { ratio: number }) {
  return (
    <div
      data-slot="aspect-ratio"
      style={
        {
          "--ratio": ratio,
        } as React.CSSProperties
      }
      className={cn("relative aspect-(--ratio)", className)}
      {...props}
    />
  )
}

export { AspectRatio }
```

3. Update the import paths to match your project.

## Usage

```tsx
import { AspectRatio } from "@/components/ui/aspect-ratio"
```

```tsx
<div className="w-96">
  <AspectRatio ratio={16 / 9} className="overflow-hidden rounded-2xl bg-muted">
    <img
      src="https://images.unsplash.com/photo-1506744038136-46273834b3fb?w=800&q=80"
      alt="Mountain lake at sunrise"
      className="size-full object-cover"
    />
  </AspectRatio>
</div>
```

Pass `ratio` as a number, typically written as a division such as `16 / 9`, `4 / 3` or `1`. Give media inside it `className="size-full object-cover"` to fill the frame. Add `overflow-hidden` and a radius class to clip the content to rounded corners.

## Examples

### Square

A `1:1` frame using `ratio={1}`.

**Example**

```tsx
import { AspectRatio } from "@/components/ui/aspect-ratio"

export default function AspectRatioSquare() {
  return (
    <div className="w-96">
      <AspectRatio ratio={1} className="overflow-hidden rounded-2xl bg-muted">
        <img
          src="https://images.unsplash.com/photo-1506744038136-46273834b3fb?w=800&q=80"
          alt="Mountain lake at sunrise"
          className="size-full object-cover"
        />
      </AspectRatio>
    </div>
  )
}
```

### Portrait

A taller-than-wide frame using `ratio={3 / 4}`.

**Example**

```tsx
import { AspectRatio } from "@/components/ui/aspect-ratio"

export default function AspectRatioPortrait() {
  return (
    <div className="w-96">
      <AspectRatio
        ratio={3 / 4}
        className="overflow-hidden rounded-2xl bg-muted"
      >
        <img
          src="https://images.unsplash.com/photo-1506744038136-46273834b3fb?w=800&q=80"
          alt="Mountain lake at sunrise"
          className="size-full object-cover"
        />
      </AspectRatio>
    </div>
  )
}
```

### Placeholder

A `4:3` frame holding centered placeholder text instead of an image.

**Example**

```tsx
import { AspectRatio } from "@/components/ui/aspect-ratio"

export default function AspectRatioPlaceholder() {
  return (
    <div className="w-96">
      <AspectRatio
        ratio={4 / 3}
        className="overflow-hidden rounded-2xl bg-muted"
      >
        <div className="text-muted-foreground flex size-full items-center justify-center text-sm">
          4:3
        </div>
      </AspectRatio>
    </div>
  )
}
```

## API Reference

### AspectRatio

The ratio-locked container.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `ratio` | `number` | Required | Width divided by height, for example `16 / 9`. Required. |

Also accepts the props of `React.ComponentProps<"div">`.

## Notes

- Styling hook: `data-slot="aspect-ratio"`.
- The ratio is passed through the `--ratio` CSS custom property and applied with the Tailwind class `aspect-(--ratio)`.

**React Native, SwiftUI, Jetpack Compose**

![Preview](https://ui.suiss.app/previews/components-aspect-ratio--default.light.webp)

```tsx
import { Image, View } from "react-native"
import { AspectRatio } from "@/components/ui/aspect-ratio"

const imageUri =
"https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80"

export function AspectRatioExample() {
  return (
    <View className="w-full overflow-hidden rounded-lg">
      <AspectRatio ratio={16 / 9}>
        <Image source={{ uri: imageUri }} className="h-full w-full" />
      </AspectRatio>
    </View>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct AspectRatioExample: View {
  var body: some View {
    AspectRatio(ratio: 16 / 9) {
      AspectRatioPhoto()
    }
    .clipShape(RoundedRectangle(cornerRadius: Radius.lg, style: .continuous))
    .frame(maxWidth: .infinity)
  }
}

struct AspectRatioPhoto: View {
  var body: some View {
    AsyncImage(
      url: URL(string: "https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80")
    ) { phase in
      if let image = phase.image {
        image.resizable().scaledToFill()
      } else {
        EsuissColor.muted
      }
    }
    .frame(maxWidth: .infinity, maxHeight: .infinity)
  }
}
```

```kotlin
import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.width
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Brush
import androidx.compose.ui.graphics.painter.BrushPainter
import androidx.compose.ui.layout.ContentScale
import androidx.compose.ui.unit.Dp
import com.adamglin.phosphoricons.regular.Image
import com.esuiss.ui.components.AspectRatio
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Palette
import com.esuiss.ui.theme.Radius

@Composable
fun AspectRatioExample() {
    AspectRatioPhoto(null, 16f / 9f)
}

@Composable
fun AspectRatioPhoto(width: Dp?, ratio: Float) {
    val colors = EsuissTheme.colors
    val photo = remember(colors) { BrushPainter(Brush.linearGradient(listOf(Palette.teal500, Palette.blue500, Palette.indigo500))) }
    Box(
        (if (width != null) Modifier.width(width) else Modifier.fillMaxWidth())
            .clip(RoundedCornerShape(Radius.lg)),
    ) {
        AspectRatio(ratio) {
            Image(photo, contentDescription = null, modifier = Modifier.fillMaxSize(), contentScale = ContentScale.Crop)
        }
    }
}
```

`AspectRatio` is a `View` that sets the `aspectRatio` style from its `ratio` prop. Its height follows from the width it is given, so the content keeps its shape at any screen size.

Use it for images, video thumbnails and placeholders that must not stretch.

## Installation

**React Native**

```bash title="Terminal"
npx shadcn@latest add @esuiss-rn/aspect-ratio
```

See [Installation](https://ui.suiss.app/docs/installation) for the `components.json` setup. Or use the suiss/ui CLI:

```bash title="Terminal"
npx @esuiss/ui@latest add aspect-ratio
```

**SwiftUI**

```bash title="Terminal"
npx @esuiss/ui@latest add aspect-ratio --platform swift
```

**Jetpack Compose**

```bash title="Terminal"
npx @esuiss/ui@latest add aspect-ratio --platform kotlin
```

### Manual

**React Native**

**Uniwind**

1. Add the pieces it builds on: the primitives `components/primitives/aspect-ratio.tsx`.

2. Copy the source into `components/ui/aspect-ratio.tsx`:

```tsx title="uniwind/components/ui/aspect-ratio.tsx"
import * as AspectRatioPrimitive from "@/components/primitives/aspect-ratio"

const AspectRatio = AspectRatioPrimitive.Root

export { AspectRatio }
```

3. Update the import paths to match your project.

**NativeWind**

1. Add the pieces it builds on: the primitives `components/primitives/aspect-ratio.tsx`.

2. Copy the source into `components/ui/aspect-ratio.tsx`:

```tsx title="nativewind/components/ui/aspect-ratio.tsx"
import * as AspectRatioPrimitive from "@/components/primitives/aspect-ratio"

const AspectRatio = AspectRatioPrimitive.Root

export { AspectRatio }
```

3. Update the import paths to match your project.

**StyleSheet**

1. Add the pieces it builds on: the primitives `components/primitives/aspect-ratio.tsx`.

2. Copy the source into `components/ui/aspect-ratio.tsx`:

```tsx title="stylesheet/components/ui/aspect-ratio.tsx"
import * as AspectRatioPrimitive from "@/components/primitives/aspect-ratio"

const AspectRatio = AspectRatioPrimitive.Root

export { AspectRatio }
```

3. Update the import paths to match your project.

**SwiftUI**

1. Target iOS 17 or later.

2. Copy the theme files every view uses:

- `swift/Theme/Theme.swift`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/swiftui/Sources/EsuissUI/Theme/Theme.swift)

- `swift/Theme/Tokens.swift`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/swiftui/Sources/EsuissUI/Theme/Tokens.swift)

3. Copy the source:

```swift title="swift/Components/AspectRatio.swift"
import SwiftUI

public struct AspectRatio<Content: View>: View {
  let ratio: CGFloat
  let content: Content

  public init(ratio: CGFloat = 1, @ViewBuilder content: () -> Content) {
    self.ratio = ratio
    self.content = content()
  }

  public var body: some View {
    Color.clear
      .aspectRatio(ratio, contentMode: .fit)
      .overlay {
        content
      }
      .clipped()
  }
}
```

4. Add the files to your app target.

**Jetpack Compose**

1. Set `minSdk` to 24 or higher and add the dependencies:

```kotlin title="build.gradle.kts"
implementation(platform("androidx.compose:compose-bom:2026.09.00"))
implementation("androidx.compose.foundation:foundation")
implementation("androidx.compose.ui:ui")
```

2. Copy the theme files every view uses:

- `kotlin/theme/Theme.kt`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/kotlin/ui/src/main/kotlin/com/esuiss/ui/theme/Theme.kt)

- `kotlin/theme/Tokens.kt`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/kotlin/ui/src/main/kotlin/com/esuiss/ui/theme/Tokens.kt)

3. Copy the source:

```kt title="kotlin/components/AspectRatio.kt"
package com.esuiss.ui.components

import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxScope
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier

@Composable
fun AspectRatio(
    ratio: Float,
    modifier: Modifier = Modifier,
    content: @Composable BoxScope.() -> Unit,
) {
    Box(
        modifier = modifier.fillMaxWidth().aspectRatio(ratio),
        propagateMinConstraints = true,
        content = content,
    )
}
```

4. Update the `com.esuiss.ui` package names to match your project.

## Usage

```tsx
<View className="w-full overflow-hidden rounded-lg">
  <AspectRatio ratio={16 / 9}>
    <Image source={{ uri: imageUri }} className="h-full w-full" />
  </AspectRatio>
</View>
```

Pass `ratio` as width divided by height, such as `16 / 9`. It defaults to `1`. Size the content inside with `h-full w-full`, and put rounding or clipping on a parent view.

## Examples

### Square

A square image with `ratio={1}`.

![Preview](https://ui.suiss.app/previews/components-aspect-ratio--square.light.webp)

```tsx
import { Image, View } from "react-native"
import { AspectRatio } from "@/components/ui/aspect-ratio"

const imageUri =
"https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80"

export function AspectRatioSquareExample() {
  return (
    <View className="w-48 overflow-hidden rounded-lg">
      <AspectRatio ratio={1}>
        <Image source={{ uri: imageUri }} className="h-full w-full" />
      </AspectRatio>
    </View>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct AspectRatioSquareExample: View {
  var body: some View {
    AspectRatio(ratio: 1) {
      AspectRatioPhoto()
    }
    .clipShape(RoundedRectangle(cornerRadius: Radius.lg, style: .continuous))
    .frame(width: 192)
  }
}

struct AspectRatioPhoto: View {
  var body: some View {
    AsyncImage(
      url: URL(string: "https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80")
    ) { phase in
      if let image = phase.image {
        image.resizable().scaledToFill()
      } else {
        EsuissColor.muted
      }
    }
    .frame(maxWidth: .infinity, maxHeight: .infinity)
  }
}
```

```kotlin
import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.width
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Brush
import androidx.compose.ui.graphics.painter.BrushPainter
import androidx.compose.ui.layout.ContentScale
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.adamglin.phosphoricons.regular.Image
import com.esuiss.ui.components.AspectRatio
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Palette
import com.esuiss.ui.theme.Radius

@Composable
fun AspectRatioSquareExample() {
    AspectRatioPhoto(192.dp, 1f)
}

@Composable
fun AspectRatioPhoto(width: Dp?, ratio: Float) {
    val colors = EsuissTheme.colors
    val photo = remember(colors) { BrushPainter(Brush.linearGradient(listOf(Palette.teal500, Palette.blue500, Palette.indigo500))) }
    Box(
        (if (width != null) Modifier.width(width) else Modifier.fillMaxWidth())
            .clip(RoundedCornerShape(Radius.lg)),
    ) {
        AspectRatio(ratio) {
            Image(photo, contentDescription = null, modifier = Modifier.fillMaxSize(), contentScale = ContentScale.Crop)
        }
    }
}
```

### Portrait

A tall image with `ratio={9 / 16}`.

![Preview](https://ui.suiss.app/previews/components-aspect-ratio--portrait.light.webp)

```tsx
import { Image, View } from "react-native"
import { AspectRatio } from "@/components/ui/aspect-ratio"

const imageUri =
"https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80"

export function AspectRatioPortraitExample() {
  return (
    <View className="w-40 overflow-hidden rounded-lg">
      <AspectRatio ratio={9 / 16}>
        <Image source={{ uri: imageUri }} className="h-full w-full" />
      </AspectRatio>
    </View>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct AspectRatioPortraitExample: View {
  var body: some View {
    AspectRatio(ratio: 9 / 16) {
      AspectRatioPhoto()
    }
    .clipShape(RoundedRectangle(cornerRadius: Radius.lg, style: .continuous))
    .frame(width: 160)
  }
}

struct AspectRatioPhoto: View {
  var body: some View {
    AsyncImage(
      url: URL(string: "https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80")
    ) { phase in
      if let image = phase.image {
        image.resizable().scaledToFill()
      } else {
        EsuissColor.muted
      }
    }
    .frame(maxWidth: .infinity, maxHeight: .infinity)
  }
}
```

```kotlin
import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.width
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Brush
import androidx.compose.ui.graphics.painter.BrushPainter
import androidx.compose.ui.layout.ContentScale
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.adamglin.phosphoricons.regular.Image
import com.esuiss.ui.components.AspectRatio
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Palette
import com.esuiss.ui.theme.Radius

@Composable
fun AspectRatioPortraitExample() {
    AspectRatioPhoto(160.dp, 9f / 16f)
}

@Composable
fun AspectRatioPhoto(width: Dp?, ratio: Float) {
    val colors = EsuissTheme.colors
    val photo = remember(colors) { BrushPainter(Brush.linearGradient(listOf(Palette.teal500, Palette.blue500, Palette.indigo500))) }
    Box(
        (if (width != null) Modifier.width(width) else Modifier.fillMaxWidth())
            .clip(RoundedCornerShape(Radius.lg)),
    ) {
        AspectRatio(ratio) {
            Image(photo, contentDescription = null, modifier = Modifier.fillMaxSize(), contentScale = ContentScale.Crop)
        }
    }
}
```

### Placeholder

A placeholder surface with an icon instead of an image.

![Preview](https://ui.suiss.app/previews/components-aspect-ratio--placeholder.light.webp)

```tsx
import { ImageIcon } from "phosphor-react-native"
import { View } from "react-native"
import { AspectRatio } from "@/components/ui/aspect-ratio"
import { Icon } from "@/components/ui/icon"
import { Text } from "@/components/ui/text"

export function AspectRatioPlaceholderExample() {
  return (
    <View className="w-full">
      <AspectRatio ratio={16 / 9}>
        <View className="bg-muted h-full w-full items-center justify-center gap-2 rounded-lg">
          <Icon as={ImageIcon} className="text-muted-foreground size-8" />
          <Text variant="muted">16 / 9</Text>
        </View>
      </AspectRatio>
    </View>
  )
}
```

```swift
import EsuissUI
import PhosphorSwift
import SwiftUI

struct AspectRatioPlaceholderExample: View {
  var body: some View {
    AspectRatio(ratio: 16 / 9) {
      VStack(spacing: 8) {
        Ph.image.regular
          .frame(width: 32, height: 32)
          .foregroundStyle(EsuissColor.mutedForeground)
        Text("16 / 9")
          .textVariant(.muted)
      }
      .frame(maxWidth: .infinity, maxHeight: .infinity)
      .background(EsuissColor.muted, in: RoundedRectangle(cornerRadius: Radius.lg, style: .continuous))
    }
    .frame(maxWidth: .infinity)
  }
}
```

```kotlin
import androidx.compose.foundation.Image
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import com.adamglin.PhosphorIcons
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.regular.Image
import com.esuiss.ui.components.AspectRatio
import com.esuiss.ui.components.Icon
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.TextVariant
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Radius

@Composable
fun AspectRatioPlaceholder() {
    val colors = EsuissTheme.colors
    AspectRatio(16f / 9f) {
        Column(
            Modifier.fillMaxSize().background(colors.muted, RoundedCornerShape(Radius.lg)),
            verticalArrangement = Arrangement.spacedBy(8.dp, Alignment.CenterVertically),
            horizontalAlignment = Alignment.CenterHorizontally,
        ) {
            Icon(PhosphorIcons.Regular.Image, contentDescription = null, size = 32.dp, tint = colors.mutedForeground)
            Text("16 / 9", variant = TextVariant.Muted)
        }
    }
}
```

## Accessibility

- The view adds no role; give images their own `accessibilityLabel`.