Include aria-hidden attribute to Image shortcodes.

[cannandev]

USWDS 3.0 adds an aria-hidden attribute to images. The two shortcodes image and image_with_class only have src, cls, alt parameters. It should also support an aria parameter.

Notes

Example: USWDS Banner

<img
  aria-hidden="true"
  class="usa-banner__header-flag"
  src="/assets/img/us_flag_small.png"
  alt=""
/>

Implementation notes

The imageWithClassShortcode function in index.js can be updated with a new parameter, whose default is true.

async function imageWithClassShortcode(
  src,
  cls,
  alt,
  aria=true,
) {
...
  return `<img src="${pathPrefix}${data.url}" class="${cls}" alt="${alt}" aria-hidden="${aria}" loading="lazy" decoding="async">`;
};

Acceptance Criteria

• Images () are generated with an aria-hidden attribute, whose default value is true
• Developers can pass a false value to the image and image_with_class shortcodes, if necessary
• Instructions in the README.md are updated.

Thanks for all your hard work! 🙇🏾‍♀️