@wolfco/inclusive-card v1.2.2

Inclusive Card

A web component to make linked cards friendlier to assistive technologies (e.g., screen readers).

Rationale

This web component is inspired by and directly emulates the card component proposed in Heydon Pickering's collection of Inclusive Components.

A traditional approach to card layouts that have a call to action in them is to wrap the entire layout in an anchor element, which is something that HTML5 made possible. However, when a screen reader (for example) encounters that layout, it will more often than not read the entirety of whatever is enclosed by the anchor element as the "content" of the anchor itself. This could include the full URL to an image in the card, a text summary, and anything else one might put in their card layouts.

This component attempts to remedy that by allowing an author to write sensible markup that isn't wrapped in an anchor element. A card that needs to be linked can have an independent anchor in the its contents. The component adds a small amount of JavaScript to send click events on the card itself to the destination specified in the href attribute of a given link within the card.

Installation and Usage

npm install @wolfco/inclusive-card

import 'inclusive-card';

<inclusive-card link-target="[data-card-link]">
  <article>
    <img src="foo" alt="foo" />
    <h1>Article Title</h1>
    <p>Article summary...</p>
    <a data-card-link href="/foo">Learn more about foo</a>
  </article>
</inclusive-card>

Attributes

The component's primary attribute is link-target, which is a string representing a CSS selector meant to identify the anchor to derive an href from. Any valid CSS selector will work. For example: link-target="[data-card-link]" or link-target="div > .link".

Exclusions

There are cases where you might have a card with a primary CTA that also has secondary CTAs, or links within article summary text. In those cases you'd need to distinguish between a link meant to apply to the entire card and links that should take a user somewhere else when clinked on directly.

For example:

<inclusive-card link-target="[data-card-link]">
  <article >
    <img src="foo" alt="foo" />
    <h1>Article Title</h1>
    <p>Lorem ipsum dolor <a href="https://some-link.com">sit amet</a>,
    consectetur <a href="https://some-other-link.com">adipisicing elit</a>.
    A aliquam aspernatur culpa delectus eaque eum ipsum.</p>
    <a data-card-link href="/foo">Learn more about foo</a>
  </article>
</inclusive-card>

In that case, you can pass an exclusions attribute to the card, which accepts a string meant to be used as a CSS selector. Items matching that string will simply behave like regular links.

<inclusive-card exclusions="[data-exclusion]" link-target="[data-card-link]">
  <article>
    <img src="foo" alt="foo" />
    <h1>Article Title</h1>
    <p>Lorem ipsum dolor <a data-exclusion href="https://some-link.com">sit amet</a>,
    consectetur <a data-exclusion href="https://some-other-link.com">adipisicing elit</a>.
    A aliquam aspernatur culpa delectus eaque eum ipsum.</p>
    <a data-card-link href="/foo">Learn more about foo</a>
  </article>
</inclusive-card>