Skip to content

fix(Tooltip): update TypeScript types for TooltipProps #3159

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
joshblack merged 3 commits into from
Apr 12, 2023
+38 −25
Merged

fix(Tooltip): update TypeScript types for TooltipProps #3159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26b5e30
fix(Tooltip): update TypeScript types for TooltipProps
joshblack Apr 12, 2023
04638f9
chore: add changeset
joshblack Apr 12, 2023
3bb0774
Merge branch 'main' into fix/update-ts-types-tooltip
joshblack Apr 12, 2023
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/dirty-files-talk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Update TooltipProps to extend from StyledTooltip props
54 changes: 29 additions & 25 deletions src/Tooltip/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,9 @@ import {invariant} from '../utils/invariant'
import styled from 'styled-components'
import {get} from '../constants'
import {useOnEscapePress} from '../hooks/useOnEscapePress'
import {ComponentProps} from '../utils/types'

export type TooltipProps = {
direction?: 'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' | 'nw'
text?: string
noDelay?: boolean
align?: 'left' | 'right'
wrap?: boolean
type?: 'label' | 'description'
'aria-label'?: React.AriaAttributes['aria-label']
} & SxProp

export type TriggerPropsType = {
'aria-describedby'?: string
'aria-labelledby'?: string
'aria-label'?: string
onBlur?: React.FocusEventHandler
onFocus?: React.FocusEventHandler
onMouseEnter?: React.MouseEventHandler
ref?: React.RefObject<HTMLElement>
}

const TooltipEL = styled.div<TooltipProps>`
const StyledTooltip = styled.div`
// tooltip element itself
position: absolute;
z-index: 1000000;
Expand Down Expand Up @@ -294,7 +275,30 @@ const TooltipEL = styled.div<TooltipProps>`
${sx};
`

export const Tooltip: React.FC<React.PropsWithChildren<TooltipProps>> = ({
export type TooltipProps = React.PropsWithChildren<
{
direction?: 'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' | 'nw'
text?: string
noDelay?: boolean
align?: 'left' | 'right'
wrap?: boolean
type?: 'label' | 'description'
'aria-label'?: React.AriaAttributes['aria-label']
} & SxProp &
ComponentProps<typeof StyledTooltip>
>

export type TriggerPropsType = {
'aria-describedby'?: string
'aria-labelledby'?: string
'aria-label'?: string
onBlur?: React.FocusEventHandler
onFocus?: React.FocusEventHandler
onMouseEnter?: React.MouseEventHandler
ref?: React.RefObject<HTMLElement>
}

export const Tooltip = ({
direction = 'n',
// used for description type
text,
Expand All @@ -306,7 +310,7 @@ export const Tooltip: React.FC<React.PropsWithChildren<TooltipProps>> = ({
type = 'label',
children,
...rest
}) => {
}: TooltipProps) => {
const id = useId()
const triggerRef = useRef<HTMLElement>(null)
const child = Children.only(children)
Expand Down Expand Up @@ -376,7 +380,7 @@ export const Tooltip: React.FC<React.PropsWithChildren<TooltipProps>> = ({
child.props.onMouseEnter?.(event)
},
})}
<TooltipEL
<StyledTooltip
data-direction={direction}
data-state={open ? 'open' : undefined}
data-align={align}
Expand All @@ -390,7 +394,7 @@ export const Tooltip: React.FC<React.PropsWithChildren<TooltipProps>> = ({
id={id}
>
{text ?? label}
</TooltipEL>
</StyledTooltip>
</Box>
)
}
4 changes: 4 additions & 0 deletions src/Tooltip/__tests__/Tooltip.types.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ export function shouldAcceptCallWithNoProps() {
return <Tooltip />
}

export function shouldAcceptAdditionalProps() {
return <Tooltip id="test" style={{}} className="test" />
}

export function shouldNotAcceptSystemProps() {
// @ts-expect-error system props should not be accepted
return <Tooltip backgroundColor="thistle" />
Expand Down