Files
react/components/tooltip/tooltip.tsx
witt 299f7741ea chore: release v2.2.0 (#602)
* feat(slider): add option to hide slider value (#494)

* feat(slider): hideValue prop added

* test(slider): test added for hideValue prop

docs(slider): add hideValue prop

docs(slider): add hideValue prop for cn docs

feat(slider): ensure the dot stays round when no content

test(slider): update snapshots

* feat(loading): apply width & height props (#500)

* feat(loading): apply width & height props

* test(loading): test case added & updating snapshots

* fix(loading): add a string type for size prop

test(loading): update test case & snapshots

* feat(loading): support custom the ratio of spaces

* docs(loading): append size and spaceRatio

test(loading): update snapshots

Co-authored-by: unix <unix.bio@gmail.com>

* chore(deps): update styled-jsx to ^3.3.1 (#520)

* chore(deps): update styled-jsx to ^3.3.1

update styled-jsx to ^3.3.1 to allow compatiblity with react@^17

* fix(modules): fix 695-issue to compatible with React 17

* docs: fix module error caused by styled-jsx update

Co-authored-by: unix <unix.bio@gmail.com>

* chore: release v2.2.0-rc.0

* fix(modal): disable backdrop even if actions missing (#532)

* fix: upgrade to be compatible with React-17's event system (#533)

* feat: useKeyboard hooks (#541)

* feat(keyboard): create keyboard hooks

* feat(usekeyboard): redesign event handler to match keyboard events from browser

\

* test(usekeyboard): add testcase

* docs(usekeyboard): create new hooks document

* chore: release v2.2.0-rc.1

* feat(auto-complete): add forwardRef for input element (#542)

* feat(auto-complete): add forwardRef for input element

* test(auto-complete): add testcase to ensure ref is available

* docs(auto-complete): append props for ref

* chore: release v2.2.0-rc.2

* fix(auto-complete): fix size of loading icon (#546)

* chore: release v2.2.0-rc.3

* fix(auto-complete): hide shadow when no content (#547)

* chore: release v2.2.0-rc.4

* feat: add status prop in checkbox, radio, select, slider and toggle (#530)

* feat: added status prop to set color by states

test: check status success, warning and error

* docs: added playground example and API reference

fix: replaced ´_´ as it's not recommended to use

fix: removed redundant return

refactor: renamed prop from status to type

test: update test with the renamed prop

* docs: update prop references from status to type

fix: status prop not updated to type

fix: missing return

* fix(select): set icons and hover state to follow the theme

* test(slider): update snapshots

* chore: always use relative paths when import types

Co-authored-by: unix <unix.bio@gmail.com>

* feat(auto-complete): add props for popup container (#558)

* feat(auto-complete): add props for popup container

* docs(auto-complete): add attribute for popup container

* chore: release v2.2.0-rc.5

* fix: fix path error under esm

* chore: release v2.2.0-rc.6

* feat(scaleable): add scaleable props to each component (#531)

* feat(scaleable): add scaleable props to each component

* chore(scaleable): update the exported type

* feat: apply scaleable to components

chore: remove with-default

test: improve testcase for scaleable

chore: resolve test warning

ci: upgrade nodejs to latest lts

docs: fix type error in document site

* docs: update documents to be compatible with scaleable

chore: fix build errors

* chore: remove all size-related attributes

docs: improve guide document

* docs: add scaleable documentation

test: update snapshots

chore: remove unused

* feat: add scaleable to grid components

* docs: improve docs

* test: update snapshots

* fix(grid): fix basic component props

* feat: export all types related to components (#562)

* feat: export all types related to components

fix(tooltip): fix the vertical offset of the arrow

* refactor: optimize events of all popup related components

* test: append testcases for popup base component

* test: add testcase for visible events

* test: update snapshots

* fix(bundle): fix modules missing in yarn berry (#563)

* chore: add peer dependencies

* fix(bundle): fix modules missing in yarn berry

* chore: upgrade configs for jest 27

* chore(examples): upgrade next examples for scaleable (#564)

* chore: release v2.2.0-rc.7

* feat(rating): a new component rating indicator (#543)

* chore(deps): bump lodash from 4.17.20 to 4.17.21 (#537)

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.20...4.17.21)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* (feature) rating state working and islocked working

* (feature) custom emojis for the ratings added

* refactor(rating): migrate component to scaleable

* feat(rating): use inline icon component

test(rating): update testcase

* docs(rating): add document for zh-cn

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: unix <unix.bio@gmail.com>

* refactor(table): redesign interfaces to improve the experience in TypeScript (#569)

* refactor(table): redesign interfaces to improve the experience in TypeScript

* docs: upgrade to new type exports

* style: fix lint warnings

* docs: fix sidebar text-transform (#570)

* docs: improve the copywriting content of the document (#571)

* docs: export individual style types for each component

* docs: improve the copywriting content of the document

* docs: optimize the document site experience on mobile devices

* chore: release v2.2.0-rc.8

* feat(modal): responds to keyboard events when modal is displayed (#574)

* docs: redesign mobile navigation (#576)

* docs: redesign mobile navigation

* docs: fix subheading active color

* fix(avatar): fix margin on first child (#578)

Co-authored-by: witt <unix.bio@gmail.com>

* feat(select): imporve the focus events to export simulated ref (#579)

* feat(select): imporve the focus events to export simulated ref

* test: improve testcase and fix warnings

* docs(select): add label and divider to props docs

* fix: rename hymlType to htmlType (#599)

* feat(drawer): create component (#575)

* feat(drawer): create component

* feat(drawer): refinement of drawer component

* test: update tool chain for jest

* test: simplify events case for jest

* docs(drawer): add playground

* docs(drawer): add api docs

* docs: add home page (#573)

* docs: add home page

* docs(homepage): apply suggestions from code review

* docs(homepage): make cards clickable

Co-authored-by: witt <unix.bio@gmail.com>

* test: update snapshots for scaleable

* chore: update lock file

* chore: upgrade styled-jsx

* test: update snapshots for styled-jsx

Co-authored-by: Deepankar <deep14bhade@gmail.com>
Co-authored-by: Deepankar <statisticsaffinity@gmail.com>
Co-authored-by: Florian Levis <levis.florian@gmail.com>
Co-authored-by: gepd <guillermoepd@hotmail.com>
Co-authored-by: Nils J <nils.jorek@gmx.de>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Ofek Ashery <ofek.ashery@gmail.com>
Co-authored-by: Sanna Jammeh <50969683+sannajammeh@users.noreply.github.com>
2021-08-13 17:31:45 +08:00

136 lines
3.7 KiB
TypeScript

import React, { useEffect, useMemo, useRef, useState } from 'react'
import TooltipContent, { TooltipIconOffset } from './tooltip-content'
import useClickAway from '../utils/use-click-away'
import { TriggerTypes, Placement, SnippetTypes } from '../utils/prop-types'
import { withScaleable } from '../use-scaleable'
import { getRect } from './helper'
export type TooltipOnVisibleChange = (visible: boolean) => void
export type TooltipTypes = SnippetTypes
export type TooltipTriggers = TriggerTypes
export type TooltipPlacement = Placement
interface Props {
text: string | React.ReactNode
type?: TooltipTypes
placement?: TooltipPlacement
visible?: boolean
initialVisible?: boolean
hideArrow?: boolean
trigger?: TooltipTriggers
enterDelay?: number
leaveDelay?: number
offset?: number
className?: string
portalClassName?: string
onVisibleChange?: TooltipOnVisibleChange
}
const defaultProps = {
initialVisible: false,
hideArrow: false,
type: 'default' as TooltipTypes,
trigger: 'hover' as TooltipTriggers,
placement: 'top' as TooltipPlacement,
enterDelay: 100,
leaveDelay: 150,
offset: 12,
className: '',
portalClassName: '',
onVisibleChange: (() => {}) as TooltipOnVisibleChange,
}
type NativeAttrs = Omit<React.HTMLAttributes<any>, keyof Props>
export type TooltipProps = Props & NativeAttrs
const TooltipComponent: React.FC<React.PropsWithChildren<TooltipProps>> = ({
children,
initialVisible,
text,
offset,
placement,
portalClassName,
enterDelay,
leaveDelay,
trigger,
type,
className,
onVisibleChange,
hideArrow,
visible: customVisible,
...props
}: React.PropsWithChildren<TooltipProps> & typeof defaultProps) => {
const timer = useRef<number>()
const ref = useRef<HTMLDivElement>(null)
const [visible, setVisible] = useState<boolean>(initialVisible)
const iconOffset = useMemo<TooltipIconOffset>(() => {
if (!ref?.current) return { x: '0.75em', y: '0.75em' }
const rect = getRect(ref)
return {
x: `${rect.width ? rect.width / 2 : 0}px`,
y: `${rect.height ? rect.height / 2 : 0}px`,
}
}, [ref?.current])
const contentProps = {
type,
visible,
offset,
placement,
hideArrow,
iconOffset,
parent: ref,
className: portalClassName,
}
const changeVisible = (nextState: boolean) => {
const clear = () => {
clearTimeout(timer.current)
timer.current = undefined
}
const handler = (nextState: boolean) => {
setVisible(nextState)
onVisibleChange(nextState)
clear()
}
clear()
if (nextState) {
timer.current = window.setTimeout(() => handler(true), enterDelay)
return
}
const leaveDelayWithoutClick = trigger === 'click' ? 0 : leaveDelay
timer.current = window.setTimeout(() => handler(false), leaveDelayWithoutClick)
}
const mouseEventHandler = (next: boolean) => trigger === 'hover' && changeVisible(next)
const clickEventHandler = () => trigger === 'click' && changeVisible(!visible)
useClickAway(ref, () => trigger === 'click' && changeVisible(false))
useEffect(() => {
if (customVisible === undefined) return
changeVisible(customVisible)
}, [customVisible])
return (
<div
ref={ref}
className={`tooltip ${className}`}
onClick={clickEventHandler}
onMouseEnter={() => mouseEventHandler(true)}
onMouseLeave={() => mouseEventHandler(false)}
{...props}>
{children}
<TooltipContent {...contentProps}>{text}</TooltipContent>
<style jsx>{`
.tooltip {
width: max-content;
display: inline-block;
}
`}</style>
</div>
)
}
TooltipComponent.defaultProps = defaultProps
TooltipComponent.displayName = 'GiestTooltip'
const Tooltip = withScaleable(TooltipComponent)
export default Tooltip