Skip to content

Fix / better typing for history location#1794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rezrah merged 5 commits into from
Jan 13, 2022
Merged

Fix / better typing for history location #1794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7075884
fix: restore string (path) in union type for Location
rezrah Jan 13, 2022
a86dffa
chore: add changeset
rezrah Jan 13, 2022
24b75a1
Merge branch 'main' of github.com:primer/react into fix/pathname-type…
rezrah Jan 13, 2022
a2d572d
chore: better typing for history location
rezrah Jan 13, 2022
46ee3d6
chore: add changeset
rezrah Jan 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-jeans-occur.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

replace `Location | Pathname` union type for `to` prop with more appropriate `To`
4 changes: 2 additions & 2 deletions src/Breadcrumbs.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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'
Expand DownExpand Up@@ -54,7 +54,7 @@ function Breadcrumbs({className, children, sx: sxProp}: React.PropsWithChildren<
}

type StyledBreadcrumbsItemProps = {
to?: Location | Pathname
to?: To
selected?: boolean
} & SxProp

Expand Down
4 changes: 2 additions & 2 deletions src/SideNav.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import {Location, Pathname} from 'history'
import {To} from 'history'

import {get} from './constants'
import styled, {css} from 'styled-components'
Expand DownExpand Up@@ -54,7 +54,7 @@ const SideNav = styled(SideNavBase)<SxProp>`
${sx};
`
type StyledSideNavLinkProps = {
to?: Location | Pathname
to?: To
selected?: boolean
variant?: 'full' | 'normal'
}
Expand Down
4 changes: 2 additions & 2 deletions src/SubNav.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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'
Expand DownExpand Up@@ -58,7 +58,7 @@ const SubNavLinks = styled.div<SubNavLinksProps>`
`

type StyledSubNavLinkProps = {
to?: Location | Pathname
to?: To
selected?: boolean
} & SxProp

Expand Down
4 changes: 2 additions & 2 deletions src/TabNav.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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'
Expand DownExpand Up@@ -32,7 +32,7 @@ function TabNav({children, 'aria-label': ariaLabel, ...rest}: TabNavProps) {
}

type StyledTabNavLinkProps = {
to?: Location | Pathname
to?: To
selected?: boolean
} & SxProp

Expand Down
4 changes: 2 additions & 2 deletions src/UnderlineNav.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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'
Expand DownExpand Up@@ -59,7 +59,7 @@ function UnderlineNav({actions, className, align, children, full, label, theme,
}

type StyledUnderlineNavLinkProps = {
to?: Location | Pathname
to?: To
selected?: boolean
} & SxProp

Expand Down