element-plus/packages/hooks/use-delayed-toggle/index.ts
Dave 8306138159
fix(hooks): [use-delayed-toggle] clear timer when call onClose (#12056)
* fix(hooks): [use-delayed-toggle] clear timer when call onClose

* test(hooks): [use-delayed-toggle] coverage 100%
2023-03-16 22:29:24 +08:00

75 lines
1.5 KiB
TypeScript

import { unref } from 'vue'
import { buildProps, isNumber } from '@element-plus/utils'
import { useTimeout } from '../use-timeout'
import type { ExtractPropTypes, ToRefs } from 'vue'
export const useDelayedToggleProps = buildProps({
/**
* @description delay of appearance, in millisecond
*/
showAfter: {
type: Number,
default: 0,
},
/**
* @description delay of disappear, in millisecond
*/
hideAfter: {
type: Number,
default: 200,
},
/**
* @description disappear automatically, in millisecond
*/
autoClose: {
type: Number,
default: 0,
},
} as const)
export type UseDelayedToggleProps = {
open: (event?: Event) => void
close: (event?: Event) => void
} & ToRefs<ExtractPropTypes<typeof useDelayedToggleProps>>
export const useDelayedToggle = ({
showAfter,
hideAfter,
autoClose,
open,
close,
}: UseDelayedToggleProps) => {
const { registerTimeout } = useTimeout()
const {
registerTimeout: registerTimeoutForAutoClose,
cancelTimeout: cancelTimeoutForAutoClose,
} = useTimeout()
const onOpen = (event?: Event) => {
registerTimeout(() => {
open(event)
const _autoClose = unref(autoClose)
if (isNumber(_autoClose) && _autoClose > 0) {
registerTimeoutForAutoClose(() => {
close(event)
}, _autoClose)
}
}, unref(showAfter))
}
const onClose = (event?: Event) => {
cancelTimeoutForAutoClose()
registerTimeout(() => {
close(event)
}, unref(hideAfter))
}
return {
onOpen,
onClose,
}
}