@illinois-toolkit/ilw-card
v1.0.0
Published
Illinois Toolkit: A card component that can be used as a container for grouping information, reminiscent of a physical note or playing card.
Downloads
26
Readme
ilw-card
Links: ilw-card in Builder | Illinois Web Theme | Toolkit Development
Overview
A card component that can be used as a container for grouping information, reminiscent of a physical note or playing card.
By default, the card is a white box with a dark border, limited in width, showing the content inside of it. There are several variations:
- The top of the card can have an image using
slot="image"
, or an icon usingslot="icon"
. - The whole card can be made clickable using the attribute
clickable
. - Text content can be centered using
align="center"
. - Color themes for
gray
,blue
,orange
,blue-gradient
andorange-gradient
. For example,theme="blue"
. - The aspect ratio of the
image
andicon
slots can be forced usingaspectRatio="16/9"
.
Slots
| Slot | Description |
|-----------------|--------------------------------------------------------------------------------------------|
| slot="image"
| Placed full-width at the top of the card. |
| slot="icon"
| Centered at the top of the card with ample spacing. |
| slot="footer"
| Content remains at the bottom of the card when the card is stretched to fit a larger area. |
Icons in clickable cards
In order for themes and hover states to color icons correctly in a clickable card, the icon needs to be colorable using
currentColor
.
CSS to apply this to the Illinois brand icons is already included,
as long as you include them as inline SVG rather than with an <img>
tag.
With other icons, you may need to apply the change. For reference, here is the relevant CSS for the Illinois icons:
ilw-card path.cls-1 {
fill: currentColor;
}
Buttons in cards
The card component overrides certain aspects of ilw-button
and ilw-buttons
elements to make them match
with the chosen theme, as well as hover states. The overrides only apply if there isn't a specific theme class
added to the buttons (eg. ilw-theme-orange
).
For clickable cards, the CSS background animation is also removed, because it doesn't really work with the card transition.
Code Examples
Basic card with buttons
<ilw-card>
<h3>Student Life</h3>
<p>Animal sciences students extend their learning and career networks beyond the classroom. </p>
<ul class="ilw-buttons">
<li><a href="#">Learn More <span class="ilw-sr-only">About Student Life</span></a></li>
<li><a href="#">Contact Us</a></li>
</ul>
</ilw-card>
Card with an image
<ilw-card>
<img src="https://picsum.photos/500/297" alt="" slot="image">
<h3>Student Life</h3>
<p>Animal sciences students extend their learning and career networks beyond the classroom. </p>
<p><a href="#" class="ilw-button">Learn More <span class="ilw-sr-only">About Student Life</span></a></p>
</ilw-card>
Clickable card
A clickable card uses the first link found in the contents as the primary link to use for the whole card. When using this form, do not wrap the whole contents of the card in a link, that is done automatically.
A clickable card can have additional buttons or links that function as normal. Clicking the card outside of those will utilize the first link in the contents.
<ilw-card clickable>
<img src="https://picsum.photos/500/297" alt="" slot="image">
<h3>
<a href="#">Student Life</a>
</h3>
<p>Animal sciences students extend their learning and career networks beyond the classroom. </p>
<p><a href="#" class="ilw-button">Contact Us</a></p>
</ilw-card>
Accessibility Notes
- Make sure to use the correct heading level for the cards based on the rest of your page, if including a heading tag.
- Images and icons on cards should generally be decorative with an empty
alt=""
attribute. If an alt text is specified, the image comes after the card content in the DOM. This ensures the heading is first for screen readers, and the image is under that heading. - Centered text can be harder to read, so avoid longer card text that's centered.
- Make sure links and buttons are descriptive, using
ilw-sr-only
if needed to add context. For example:
<a href="#" class="ilw-button">Learn More <span class="ilw-sr-only">About Cards</span></a>
Note that WCAG Label in Name specifies that the name and label must begin with the same words, so the hidden portion should be at the end.
Upgrade Process
When upgrading from the v2 toolkit component, the following changes are needed:
- Rename all
il-card
toilw-card
. - Rename all
il-clickable-card
toilw-card
and add theclickable
attribute. - Add
slot="image"
to theimg
tag in cards with images. - Add
slot="icon"
to the icon in cards with icons. - Replace uses of the theme classes with an attribute:
class="il-theme-gray"
->theme="gray"
class="il-theme-blue"
->theme="blue"
class="il-theme-white"
->theme="white"
class="il-theme-blue-gradient"
->theme="blue-gradient"
class="il-theme-orange"
->theme="orange"
class="il-theme-orange-gradient"
->theme="orange-gradient"
External References
- https://www.nngroup.com/articles/cards-component/
- https://inclusive-components.design/cards/
- https://design-system.w3.org/components/cards.html