From 6b36e9f6df359e651adf04ba94a2cae61d33839c Mon Sep 17 00:00:00 2001 From: Mikaelia Date: Fri, 18 Dec 2020 20:20:24 -0800 Subject: [PATCH 1/3] Update tags package prop docs --- packages/tags/src/elements/Tag.tsx | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/packages/tags/src/elements/Tag.tsx b/packages/tags/src/elements/Tag.tsx index 902b8e8abfc..c4e4b3878a0 100644 --- a/packages/tags/src/elements/Tag.tsx +++ b/packages/tags/src/elements/Tag.tsx @@ -11,16 +11,19 @@ import { StyledTag, StyledAvatar } from '../styled'; import Close from './Close'; interface ITagProps extends HTMLAttributes { + /** Adjusts font size and padding */ size?: 'small' | 'medium' | 'large'; /** - * Apply a custom tag hue – typically constrained to a + * Sets the color of the tag. Refer to * [palette](https://zendeskgarden.github.io/react-components/theming/#palette) - * hue, but with the ability to override using any hex value. + * for available colors. Accepts any hex value. */ hue?: string; + /** Applies pill styling */ isPill?: boolean; + /** Applies round styling */ isRound?: boolean; - /** Style using regular (non-bold) font weight */ + /** Applies regular (non-bold) `font-weight` */ isRegular?: boolean; } From 3c4c379ca2f3b904332751ae648ea6eb57748fdc Mon Sep 17 00:00:00 2001 From: Mikaelia Date: Mon, 21 Dec 2020 12:49:07 -0800 Subject: [PATCH 2/3] Update tag prop description --- packages/tags/src/elements/Tag.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tags/src/elements/Tag.tsx b/packages/tags/src/elements/Tag.tsx index c4e4b3878a0..9736327010d 100644 --- a/packages/tags/src/elements/Tag.tsx +++ b/packages/tags/src/elements/Tag.tsx @@ -21,7 +21,7 @@ interface ITagProps extends HTMLAttributes { hue?: string; /** Applies pill styling */ isPill?: boolean; - /** Applies round styling */ + /** Applies styles to round the tag */ isRound?: boolean; /** Applies regular (non-bold) `font-weight` */ isRegular?: boolean; From 9c7d097f84282a5b3fe85c1f86d9b305ddc123dc Mon Sep 17 00:00:00 2001 From: Mikaelia Date: Mon, 21 Dec 2020 18:04:14 -0800 Subject: [PATCH 3/3] Update per PR comments --- packages/tags/src/elements/Tag.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/tags/src/elements/Tag.tsx b/packages/tags/src/elements/Tag.tsx index 9736327010d..647e2447cbf 100644 --- a/packages/tags/src/elements/Tag.tsx +++ b/packages/tags/src/elements/Tag.tsx @@ -15,7 +15,7 @@ interface ITagProps extends HTMLAttributes { size?: 'small' | 'medium' | 'large'; /** * Sets the color of the tag. Refer to - * [palette](https://zendeskgarden.github.io/react-components/theming/#palette) + * [PALETTE](/components/palette#palette) * for available colors. Accepts any hex value. */ hue?: string; @@ -23,7 +23,7 @@ interface ITagProps extends HTMLAttributes { isPill?: boolean; /** Applies styles to round the tag */ isRound?: boolean; - /** Applies regular (non-bold) `font-weight` */ + /** Applies regular (non-bold) font weight */ isRegular?: boolean; }