From 9ac849aca8d593fcc17f30f6461175ceb9a51bc8 Mon Sep 17 00:00:00 2001 From: Daniel Adams Date: Mon, 8 Jan 2024 18:22:50 +0100 Subject: [PATCH 1/2] Update Link inline prop description --- src/Link/Link.docs.json | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/Link/Link.docs.json b/src/Link/Link.docs.json index 1b7f4b0a0b9..1a7623bcdc5 100644 --- a/src/Link/Link.docs.json +++ b/src/Link/Link.docs.json @@ -15,25 +15,26 @@ "name": "muted", "type": "boolean", "defaultValue": "false", - "description": "Uses a less prominent shade for Link color, and the default link shade on hover" + "description": "Uses a less prominent shade for Link color, and the default link shade on hover." }, { "name": "inline", "type": "boolean", "defaultValue": "false", - "description": "Tag link inside a text block" + "description": "Set to true for links adjacent to text, underlining them for clear visibility and improved accessibility." }, { "name": "underline", "type": "boolean", "defaultValue": "false", - "description": "Adds underline to the Link" + "description": "Adds underline to the Link", + "deprecated": true }, { "name": "hoverColor", "type": "string", "defaultValue": "", - "description": "Color used when hovering over link" + "description": "Color used when hovering over the link." }, { "name": "ref", From 9b53a27071f6d885ac5888b60e5954de89bae187 Mon Sep 17 00:00:00 2001 From: Daniel Adams Date: Tue, 9 Jan 2024 09:37:21 +0100 Subject: [PATCH 2/2] Add changeset --- .changeset/nice-seals-decide.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/nice-seals-decide.md diff --git a/.changeset/nice-seals-decide.md b/.changeset/nice-seals-decide.md new file mode 100644 index 00000000000..78f8629ffb1 --- /dev/null +++ b/.changeset/nice-seals-decide.md @@ -0,0 +1,5 @@ +--- +'@primer/react': patch +--- + +Deprecate the `underline` property of the Link component in favor of the new `inline` property to better handle link visibility and accessibility when adjacent to text.