R
fn

useMax

v0.0.15testeddemo

Reactively compute the maximum of the provided numbers. Accepts either a variadic list of numbers (each a ref, getter, or raw value) or a single reactive array whose items may themselves be refs/getters.

Examples

ts
const a = ref(1);
const b = ref(3);
const max = useMax(a, b, 2); // 3
ts
const list = ref([1, 5, 2]);
const max = useMax(list); // 5
ts
const list = ref([ref(1), () => 5, 2]);
const max = useMax(list); // 5

Demo

Loading demo…

Signatures

ts
export function useMax(array: MaybeRefOrGetter<Array<MaybeRefOrGetter<number>>>): ComputedRef<number>;
ts
export function useMax(...args: Array<MaybeRefOrGetter<number>>): ComputedRef<number>;

Parameters

ParameterTypeDescription
args?MaybeComputedRefArgs<number>The values to compare, or a single reactive array of values

Returns

ComputedRef<number>A computed ref of the largest value (`-Infinity` when empty)