From eb2ac5b474c2ab61cd40bf90fe75958d9d325f08 Mon Sep 17 00:00:00 2001 From: Armagan Ersoz Date: Mon, 30 Jan 2023 14:15:04 +1000 Subject: [PATCH 1/4] Issue @deprecate notice for the UnderlineNav v1 --- src/UnderlineNav.tsx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/UnderlineNav.tsx b/src/UnderlineNav.tsx index d7efdfec27d..03a5f323d40 100644 --- a/src/UnderlineNav.tsx +++ b/src/UnderlineNav.tsx @@ -111,4 +111,7 @@ const UnderlineNavLink = styled.a.attrs(props => ({ UnderlineNavLink.displayName = 'UnderlineNav.Link' export type UnderlineNavLinkProps = ComponentProps +/** + * @deprecated UnderlineNav to be deprecated in the next major Primer React release. Please use the new responsive and accessible UnderlineNav. See https://primer.style/react/drafts/UnderlineNav2 for more details. + */ export default Object.assign(UnderlineNav, {Link: UnderlineNavLink}) From 8635c36bb705785f0e910166b292cc41ac9c14e8 Mon Sep 17 00:00:00 2001 From: Armagan Ersoz Date: Mon, 30 Jan 2023 14:29:19 +1000 Subject: [PATCH 2/4] Add changeset --- .changeset/dull-lies-count.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/dull-lies-count.md diff --git a/.changeset/dull-lies-count.md b/.changeset/dull-lies-count.md new file mode 100644 index 00000000000..ef99402b69f --- /dev/null +++ b/.changeset/dull-lies-count.md @@ -0,0 +1,5 @@ +--- +'@primer/react': minor +--- + +Issue a deprecation notice for UnderlineNav v1 From ec60106237d1df33d455b55eb97b19a2fb2895d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arma=C4=9Fan?= Date: Mon, 6 Feb 2023 11:04:39 +1000 Subject: [PATCH 3/4] Update src/UnderlineNav.tsx Co-authored-by: Josh Black --- src/UnderlineNav.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/UnderlineNav.tsx b/src/UnderlineNav.tsx index 03a5f323d40..a4c43803c1c 100644 --- a/src/UnderlineNav.tsx +++ b/src/UnderlineNav.tsx @@ -112,6 +112,6 @@ UnderlineNavLink.displayName = 'UnderlineNav.Link' export type UnderlineNavLinkProps = ComponentProps /** - * @deprecated UnderlineNav to be deprecated in the next major Primer React release. Please use the new responsive and accessible UnderlineNav. See https://primer.style/react/drafts/UnderlineNav2 for more details. + * @deprecated UnderlineNav is deprecated and will be replaced by the draft `UnderlineNav` in the next major release. See https://primer.style/react/drafts/UnderlineNav2 for more details. */ export default Object.assign(UnderlineNav, {Link: UnderlineNavLink}) From e6156194c3f8fe6f2a9c7a328de86c8a994384e2 Mon Sep 17 00:00:00 2001 From: Armagan Ersoz Date: Mon, 6 Feb 2023 11:18:58 +1000 Subject: [PATCH 4/4] Add deprecation notice on the docs --- docs/content/UnderlineNav.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/content/UnderlineNav.mdx b/docs/content/UnderlineNav.mdx index 42daa647b4e..2290159878f 100644 --- a/docs/content/UnderlineNav.mdx +++ b/docs/content/UnderlineNav.mdx @@ -8,6 +8,10 @@ import data from '../../src/UnderlineNav.docs.json' Use the UnderlineNav component to style navigation with a minimal underlined selected state, typically used for navigation placed at the top of the page. +## Deprecation + +UnderlineNav is deprecated and will be replaced by the draft `UnderlineNav` in the next major release. See [the draft UnderlineNav's docs](/drafts/UnderlineNav2) for more details. + To use UnderlineNav with [react-router](https://github.com/ReactTraining/react-router) or [react-router-dom](https://www.npmjs.com/package/react-router-dom), pass `as={NavLink}` and omit the `selected` prop.