Skip to content

Illuminate Documentation

Illuminate

Home

Cards

Learn how to use the Card component in your documentation to organize and link content.



Overview

Cards can be added individually or as a group to highlight, organize, and link content. Cards include a Phosphor icon, title, body, and link. If cards are added as a group, they will be displayed in a two-column layout on larger screens. Otherwise, they will span the full width of the article body. Cards are typically used to link to other pages, but they can also be used without a link to simply highlight information.


Properties

Card

NameTypeDescription
hrefstringRelative link to another page.
iconstringName of a Phosphor icon. Must be in React (PascalCase) format.
title requiredstringTitle of the card that will appear in bold.

CardGrid

The CardGrid component does not have any applicable properties.


Examples

individual-card-with-link.mdx

<Card title="Card Title" icon="Circle" href="#" >
This is the card body.
</Card>

individual-card-without-link.mdx

<Card title="Card Title" icon="Circle" >
This is a card without a link defined. It does not have a hover effect.
</Card>

Group of cards

CardGrid is used to group multiple cards. Cards grouped within CardGrid are presented in a two-column grid on larger screens and as a one-column grid on smaller screens.

group-of-cards.mdx

<CardGrid>
<Card title="Card One" href="#" icon="NumberCircleOne">
This is the first card.
</Card>
<Card title="Card Two" href="#" icon="NumberCircleTwo">
This is the second card.
</Card>
<Card title="Card Three" href="#" icon="NumberCircleThree">
This is the third card.
</Card>
<Card title="Card Four" href="#" icon="NumberCircleFour">
This is the fourth card.
</Card>
</CardGrid>


Built with by