Skip to content
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.

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

fix(useTransition)!: rename type TransitionOptions to UseTransitionOptions #1893

Merged
merged 1 commit into from Jul 13, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/core/useTransition/index.ts
Expand Up @@ -17,7 +17,7 @@ type EasingFunction = (n: number) => number
/**
* Transition options
*/
export interface TransitionOptions {
export interface UseTransitionOptions {
/**
* Milliseconds to wait before starting transition
*/
Expand Down Expand Up @@ -112,13 +112,13 @@ function createEasingFunction([p0, p1, p2, p3]: CubicBezierPoints): EasingFuncti
}

// option 1: reactive number
export function useTransition(source: Ref<number>, options?: TransitionOptions): ComputedRef<number>
export function useTransition(source: Ref<number>, options?: UseTransitionOptions): ComputedRef<number>

// option 2: static array of possibly reactive numbers
export function useTransition<T extends MaybeRef<number>[]>(source: [...T], options?: TransitionOptions): ComputedRef<{ [K in keyof T]: number }>
export function useTransition<T extends MaybeRef<number>[]>(source: [...T], options?: UseTransitionOptions): ComputedRef<{ [K in keyof T]: number }>

// option 3: reactive array of numbers
export function useTransition<T extends Ref<number[]>>(source: T, options?: TransitionOptions): ComputedRef<number[]>
export function useTransition<T extends Ref<number[]>>(source: T, options?: UseTransitionOptions): ComputedRef<number[]>

/**
* Transition between values.
Expand All @@ -129,7 +129,7 @@ export function useTransition<T extends Ref<number[]>>(source: T, options?: Tran
*/
export function useTransition(
source: Ref<number | number[]> | MaybeRef<number>[],
options: TransitionOptions = {},
options: UseTransitionOptions = {},
): ComputedRef<any> {
const {
delay = 0,
Expand Down