Card

<auro-card> is highly customizable HTML custom element is a type of UI design component that display content and actions about a single topic.

Use Cases

The <auro-card> element can be use in a variety of ways, including:

• Navigation: Cards can be used for navigation purposes.
• Featured information: Cards can be used to display featured information or related content.
• Content containers: Cards can be used to organize information consistently within a page.
• Grouping information: Cards can be used to group information.
• Providing a visual hierarchy: Cards can provide a clear visual hierarchy, organizing information into brief, self-contained units.
• Providing an overview: Cards can serve as an overview and an entry point for more detailed information.
• Providing a summary: Cards can present a summary and link to additional details.

Install

$ npm i @aurodesignsystem/auro-card

Define Dependency in Project

Defining the dependency within each project that is using the <auro-card> component.

import "@aurodesignsystem/auro-card";

Use CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.

<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-card@latest/+esm"></script>

Basic Example

<div style="display: flex; justify-content: flex-start; flex-wrap: wrap; gap: 4rem;">
  <auro-card>
    <img
      slot="image"
      src="https://picsum.photos/300/300?random=0"
      alt="Random insert"/>
    <auro-header slot="header" level="2" display="500">Display card title here</auro-header>
    <p slot="description">
      Context goes here.
    </p>
    <div slot="cta">
      <auro-hyperlink href="/" type="nav" target="_blank">
        More info
      </auro-hyperlink>
    </div>
  </auro-card>
  <auro-card style="max-width: 300px">
    <img
      slot="image"
      src="https://picsum.photos/300/200?random=1"
      alt="Random insert"/>
    <auro-header slot="header" level="2" display="500">Display card title here</auro-header>
    <p slot="description">
      Context goes here. Use this area to communicate more information to your users.
    </p>
    <div slot="cta">
      <auro-hyperlink href="/" nav target="_blank" type="cta">
        More info
      </auro-hyperlink>
    </div>
  </auro-card>
  <auro-card style="max-width: 150px">
    <img
      slot="image"
      src="https://picsum.photos/150/250?random=1"
      alt="Random insert"/>
    <auro-header slot="header" level="2" display="500">Display title</auro-header>
    <p slot="description">
      Context goes here.
    </p>
    <div slot="cta">
      <auro-hyperlink href="/" type="nav" target="_blank">
        More info
      </auro-hyperlink>
    </div>
  </auro-card>
</div>

Custom Component Registration for Version Management

There are two key parts to every Auro component: the class and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.

When you install the component as described on the Install page, the class is imported automatically, and the component is registered globally for you.

However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.

You can do this by importing only the component class and using the register(name) method with a unique name:

// Import the class only
import { AuroCard } from '@aurodesignsystem/auro-card/class';

// Register with a custom name if desired
AuroCard.register('custom-card');

This will create a new custom element <custom-card> that behaves exactly like <auro-card>, allowing both to coexist on the same page without interfering with each other.

<custom-card>
  <img
    slot="image"
    src="https://picsum.photos/300/300?random=0"
    alt="Random insert"/>
  <h3 slot="header">Card Title</h3>
  <p slot="description">
    Context goes here.
  </p>
  <div slot="cta">
    <auro-hyperlink href="/" type="nav" target="_blank">
      More info
    </auro-hyperlink>
  </div>
</custom-card>