From daed1b5835dd6ddac288f3071738f6499793ea33 Mon Sep 17 00:00:00 2001 From: Kyle Suss Date: Wed, 26 Jun 2019 08:29:45 -0600 Subject: [PATCH] Update Icon comments for formatting in docs mode --- src/components/Icon.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/components/Icon.js b/src/components/Icon.js index 62a34cf5..d5f4f68e 100644 --- a/src/components/Icon.js +++ b/src/components/Icon.js @@ -18,8 +18,9 @@ const Path = styled.path` /** * An Icon is a piece of visual element, but we must ensure its accessibility while using it. * It can have 2 purposes: - * - decorative only: for example, it illustrate a label next to it. We must ensure that it is ignored by screen readers, by setting `aria-hidden` attribute (ex: ) - * - non-decorative: it means that it delivers an information. For example, an icon as only child inn a button. The meaning can be obvious visually, but it must have a proper text alternative via `aria-label` for screen readers. (ex: ) + * + * - *decorative only*: for example, it illustrates a label next to it. We must ensure that it is ignored by screen readers, by setting `aria-hidden` attribute (ex: ``) + * - *non-decorative*: it means that it delivers information. For example, an icon as only child in a button. The meaning can be obvious visually, but it must have a proper text alternative via `aria-label` for screen readers. (ex: ``) */ export function Icon({ icon, block, ...props }) { return (