Skip to content
On this page

createGenericProjection

Category
Export Size
210 B
Package
@vueuse/math
Last Changed
2 months ago
Related

Generic version of createProjection Accepts a custom projector function to map arbitrary type of domains.

Refer to createProjectionand useProjection

Type Declarations

export declare type ProjectorFunction<F, T> = (
  input: F,
  from: readonly [F, F],
  to: readonly [T, T]
) => T
export declare type UseProjection<F, T> = (
  input: MaybeComputedRef<F>
) => ComputedRef<T>
export declare function createGenericProjection<F = number, T = number>(
  fromDomain: MaybeComputedRef<readonly [F, F]>,
  toDomain: MaybeComputedRef<readonly [T, T]>,
  projector: ProjectorFunction<F, T>
): UseProjection<F, T>
export declare type ProjectorFunction<F, T> = (
  input: F,
  from: readonly [F, F],
  to: readonly [T, T]
) => T
export declare type UseProjection<F, T> = (
  input: MaybeComputedRef<F>
) => ComputedRef<T>
export declare function createGenericProjection<F = number, T = number>(
  fromDomain: MaybeComputedRef<readonly [F, F]>,
  toDomain: MaybeComputedRef<readonly [T, T]>,
  projector: ProjectorFunction<F, T>
): UseProjection<F, T>

Source

SourceDocs

Contributors

Changelog

v8.9.2 on 7/12/2022
0de42 - feat(useProjection)!: rework useProjection (#1822)

Released under the MIT License.