Aspect Ratio
Displays content while maintaining a specified aspect ratio, ensuring consistent visual proportions.
Structure
Reusable Component
If you plan on using a lot of AspectRatio
components throughout your application, you can create a reusable component that combines the AspectRatio.Root
and whatever other elements you'd like to render within it. In the following example, we're creating a reusable MyAspectRatio
component that takes in a src
prop and renders an img
element with the src
prop.
You can then use the MyAspectRatio
component in your application like so:
Custom Ratio
Use the ratio
prop to set a custom aspect ratio for the image.
API Reference
The aspect ratio component.
Property | Type | Description |
---|---|---|
ratio | number | The desired aspect ratio. Default: 1 |
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-aspect-ratio-root | '' | Present on the root element. |