Skip to content
WebJs
Menu

Aspect Ratio

Displays content within a desired ratio.

Photo
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { aspectRatioClass } from '#components/ui/aspect-ratio.ts';

export default function AspectRatioDemo() {
  return html`
    <div class="w-full max-w-sm">
      <div data-slot="aspect-ratio" style="aspect-ratio: 16 / 9" class=${cn(aspectRatioClass(), 'rounded-lg bg-muted')}>
        <img
          src="https://avatar.vercel.sh/shadcn1"
          alt="Photo"
          class="absolute inset-0 h-full w-full rounded-lg object-cover grayscale dark:brightness-20"
        >
      </div>
    </div>
  `;
}
View Code

Installation

pnpm dlx @webjsdev/ui add aspect-ratio

Usage

import { aspectRatioClass } from '#components/ui/aspect-ratio.ts';
<div data-slot="aspect-ratio" style="aspect-ratio: 16 / 9" class=${aspectRatioClass()}>
  <img src="..." alt="Image" class="absolute inset-0 h-full w-full rounded-md object-cover">
</div>

Square

A square aspect ratio component using style="aspect-ratio: 1 / 1". This is useful for displaying images in a square format.

Photo
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { aspectRatioClass } from '#components/ui/aspect-ratio.ts';

export default function AspectRatioSquare() {
  return html`
    <div class="w-full max-w-[12rem]">
      <div data-slot="aspect-ratio" style="aspect-ratio: 1 / 1" class=${cn(aspectRatioClass(), 'rounded-lg bg-muted')}>
        <img
          src="https://avatar.vercel.sh/shadcn1"
          alt="Photo"
          class="absolute inset-0 h-full w-full rounded-lg object-cover grayscale dark:brightness-20"
        >
      </div>
    </div>
  `;
}
View Code

Portrait

A portrait aspect ratio component using style="aspect-ratio: 9 / 16". This is useful for displaying images in a portrait format.

Photo
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { aspectRatioClass } from '#components/ui/aspect-ratio.ts';

export default function AspectRatioPortrait() {
  return html`
    <div class="w-full max-w-[10rem]">
      <div data-slot="aspect-ratio" style="aspect-ratio: 9 / 16" class=${cn(aspectRatioClass(), 'rounded-lg bg-muted')}>
        <img
          src="https://avatar.vercel.sh/shadcn1"
          alt="Photo"
          class="absolute inset-0 h-full w-full rounded-lg object-cover grayscale dark:brightness-20"
        >
      </div>
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

Photo
منظر طبيعي جميل
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { aspectRatioClass } from '#components/ui/aspect-ratio.ts';

const translations = {
  en: {
    dir: 'ltr',
    values: {
      caption: 'Beautiful landscape',
    },
  },
  ar: {
    dir: 'rtl',
    values: {
      caption: 'منظر طبيعي جميل',
    },
  },
  he: {
    dir: 'rtl',
    values: {
      caption: 'נוף יפה',
    },
  },
};

export default function AspectRatioRtl() {
  const lang = 'ar';
  const { dir, values: t } = translations[lang];

  return html`
    <figure class="w-full max-w-sm" dir=${dir} lang=${lang}>
      <div data-slot="aspect-ratio" style="aspect-ratio: 16 / 9" class=${cn(aspectRatioClass(), 'rounded-lg bg-muted')}>
        <img
          src="https://avatar.vercel.sh/shadcn1"
          alt="Photo"
          class="absolute inset-0 h-full w-full rounded-lg object-cover grayscale dark:brightness-20"
        >
      </div>
      <figcaption class="mt-2 text-center text-sm text-muted-foreground">${t.caption}</figcaption>
    </figure>
  `;
}
View Code

API Reference

aspectRatioClass

aspectRatioClass() returns the classes for the box that holds content within a desired ratio. It takes no options: the ratio is the CSS aspect-ratio property, set inline or with a Tailwind class such as aspect-video or aspect-[4/3]. Position the content inside with absolute inset-0 so it fills the box.

AttributeTypeRequired
style="aspect-ratio: …"stringYes
classstringNo