Skip to content

Commit 01bcdaa

Browse files
Export new UnderlineNav in main and deprecate the other
1 parent 1266b10 commit 01bcdaa

File tree

11 files changed

+26
-14
lines changed

11 files changed

+26
-14
lines changed

.changeset/slow-humans-visit.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@primer/react': major
3+
---
4+
5+
Promoto newly written UnderlineNav to the main bundle and deprecate the old UnderlineNav

src/__tests__/__snapshots__/exports.test.ts.snap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ exports[`@primer/react/decprecated should not update exports without a semver ch
122122
"Relative",
123123
"SelectMenu",
124124
"Sticky",
125+
"UnderlineNav",
125126
]
126127
`;
127128

src/__tests__/UnderlineNav.test.tsx renamed to src/__tests__/deprecated/UnderlineNav.test.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import React from 'react'
2-
import {UnderlineNav} from '..'
3-
import {render, rendersClass, behavesAsComponent, checkExports} from '../utils/testing'
2+
import {UnderlineNav} from '../../deprecated'
3+
import {render, rendersClass, behavesAsComponent, checkExports} from '../../utils/testing'
44
import {render as HTMLRender} from '@testing-library/react'
55
import {axe} from 'jest-axe'
66

77
describe('UnderlineNav', () => {
88
behavesAsComponent({Component: UnderlineNav})
99

10-
checkExports('UnderlineNav', {
10+
checkExports('deprecated/UnderlineNav', {
1111
default: UnderlineNav,
1212
})
1313

src/__tests__/UnderlineNav.types.test.tsx renamed to src/__tests__/deprecated/UnderlineNav.types.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React from 'react'
2-
import UnderlineNav from '../UnderlineNav'
2+
import {UnderlineNav} from '../../deprecated'
33

44
export function shouldAcceptCallWithNoProps() {
55
return (

src/__tests__/UnderlineNavLink.test.tsx renamed to src/__tests__/deprecated/UnderlineNavLink.test.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react'
2-
import {UnderlineNav} from '..'
3-
import {render, behavesAsComponent} from '../utils/testing'
2+
import {UnderlineNav} from '../../deprecated'
3+
import {render, behavesAsComponent} from '../../utils/testing'
44
import {render as HTMLRender} from '@testing-library/react'
55
import {axe, toHaveNoViolations} from 'jest-axe'
66

src/UnderlineNav.tsx renamed to src/deprecated/UnderlineNav.tsx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ import classnames from 'classnames'
22
import {To} from 'history'
33
import React from 'react'
44
import styled from 'styled-components'
5-
import {get} from './constants'
6-
import sx, {SxProp} from './sx'
7-
import {ComponentProps} from './utils/types'
8-
import getGlobalFocusStyles from './_getGlobalFocusStyles'
5+
import {get} from '../constants'
6+
import sx, {SxProp} from '../sx'
7+
import {ComponentProps} from '../utils/types'
8+
import getGlobalFocusStyles from '../_getGlobalFocusStyles'
99

1010
const ITEM_CLASS = 'PRC-UnderlineNav-item'
1111
const SELECTED_CLASS = 'PRC-selected'
@@ -111,4 +111,7 @@ const UnderlineNavLink = styled.a.attrs<StyledUnderlineNavLinkProps>(props => ({
111111
UnderlineNavLink.displayName = 'UnderlineNav.Link'
112112

113113
export type UnderlineNavLinkProps = ComponentProps<typeof UnderlineNavLink>
114+
/**
115+
* @deprecated Use the new responsive and accessible UnderlineNav. See https://primer.style/react/UnderlineNav for more details.
116+
*/
114117
export default Object.assign(UnderlineNav, {Link: UnderlineNavLink})

src/deprecated/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,7 @@ export type {
7272
ButtonCloseProps,
7373
} from './Button'
7474
// end of v35.0.0
75+
76+
// Will be deprecated in v36.0.0
77+
export {default as UnderlineNav} from './UnderlineNav'
78+
export type {UnderlineNavProps, UnderlineNavLinkProps} from './UnderlineNav'

src/drafts/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ export type {MarkdownViewerProps, InteractiveMarkdownViewerProps} from './Markdo
2323
export {default as MarkdownEditor} from './MarkdownEditor'
2424
export * from './MarkdownEditor'
2525

26-
export * from '../UnderlineNav2'
27-
2826
export * from './hooks'
2927

3028
export * from '../TreeView'
@@ -33,3 +31,4 @@ export * from '../TreeView'
3331
export * from '../NavList'
3432
export * from '../SegmentedControl'
3533
export * from '../SplitPageLayout'
34+
export * from '../UnderlineNav2'

src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ export {default as Tooltip} from './Tooltip'
170170
export type {TooltipProps} from './Tooltip'
171171
export {default as Truncate} from './Truncate'
172172
export type {TruncateProps} from './Truncate'
173-
export {default as UnderlineNav} from './UnderlineNav'
174-
export type {UnderlineNavProps, UnderlineNavLinkProps} from './UnderlineNav'
173+
export {UnderlineNav} from './UnderlineNav2'
174+
export type {UnderlineNavProps, UnderlineNavItemProps} from './UnderlineNav2'
175175

176176
export {default as Checkbox} from './Checkbox'
177177
export type {CheckboxProps} from './Checkbox'

0 commit comments

Comments
 (0)