Fix / better typing for history location (#1794)

* fix: restore string (path) in union type for Location * chore: add changeset * chore: better typing for history location * chore: add changeset
primer · Jan 13, 2022 · a8c427d · a8c427d
1 parent 6a8472b
commit a8c427d
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 10 deletions.
diff --git a/.changeset/gorgeous-jeans-occur.md b/.changeset/gorgeous-jeans-occur.md
@@ -0,0 +1,5 @@
+---
+'@primer/react': patch
+---
+
+replace `Location | Pathname` union type for `to` prop with more appropriate `To`
diff --git a/src/Breadcrumbs.tsx b/src/Breadcrumbs.tsx
@@ -1,5 +1,5 @@
 import classnames from 'classnames'
-import {Location, Pathname} from 'history'
+import {To} from 'history'
 import React from 'react'
 import styled from 'styled-components'
 import Box from './Box'
@@ -54,7 +54,7 @@ function Breadcrumbs({className, children, sx: sxProp}: React.PropsWithChildren<
 }
 
 type StyledBreadcrumbsItemProps = {
-  to?: Location | Pathname
+  to?: To
   selected?: boolean
 } & SxProp
 

diff --git a/src/SideNav.tsx b/src/SideNav.tsx
@@ -1,4 +1,4 @@
-import {Location, Pathname} from 'history'
+import {To} from 'history'
 
 import {get} from './constants'
 import styled, {css} from 'styled-components'
@@ -54,7 +54,7 @@ const SideNav = styled(SideNavBase)<SxProp>`
   ${sx};
 `
 type StyledSideNavLinkProps = {
-  to?: Location | Pathname
+  to?: To
   selected?: boolean
   variant?: 'full' | 'normal'
 }

diff --git a/src/SubNav.tsx b/src/SubNav.tsx
@@ -1,5 +1,5 @@
 import classnames from 'classnames'
-import {Location, Pathname} from 'history'
+import {To} from 'history'
 import React from 'react'
 import styled from 'styled-components'
 import {get} from './constants'
@@ -58,7 +58,7 @@ const SubNavLinks = styled.div<SubNavLinksProps>`
 `
 
 type StyledSubNavLinkProps = {
-  to?: Location | Pathname
+  to?: To
   selected?: boolean
 } & SxProp
 

diff --git a/src/TabNav.tsx b/src/TabNav.tsx
@@ -1,5 +1,5 @@
 import classnames from 'classnames'
-import {Location, Pathname} from 'history'
+import {To} from 'history'
 import React from 'react'
 import styled from 'styled-components'
 import {get} from './constants'
@@ -32,7 +32,7 @@ function TabNav({children, 'aria-label': ariaLabel, ...rest}: TabNavProps) {
 }
 
 type StyledTabNavLinkProps = {
-  to?: Location | Pathname
+  to?: To
   selected?: boolean
 } & SxProp
 

diff --git a/src/UnderlineNav.tsx b/src/UnderlineNav.tsx
@@ -1,5 +1,5 @@
 import classnames from 'classnames'
-import {Location, Pathname} from 'history'
+import {To} from 'history'
 import React from 'react'
 import styled from 'styled-components'
 import {get} from './constants'
@@ -59,7 +59,7 @@ function UnderlineNav({actions, className, align, children, full, label, theme,
 }
 
 type StyledUnderlineNavLinkProps = {
-  to?: Location | Pathname
+  to?: To
   selected?: boolean
 } & SxProp