useCounter

カテゴリ

ユーティリティ

エクスポートサイズ

185 B

最終更新日

先週

ユーティリティ関数付きの基本的なカウンター。

デモ

ソースコード

カウント: 0

基本的な使用方法

JavaScript

import { useCounter } from '@vueuse/core'

const { count, inc, dec, set, reset } = useCounter()

オプションを使用した使用方法

JavaScript

import { useCounter } from '@vueuse/core'

const { count, inc, dec, set, reset } = useCounter(1, { min: 0, max: 16 })

型定義

TypeScript

export interface UseCounterOptions {
  min?: number
  max?: number
}
/**
 * Basic counter with utility functions.
 *
 * @see https://vueuse.dokyumento.jp/useCounter
 * @param [initialValue]
 * @param options
 */
export declare function useCounter(
  initialValue?: MaybeRef<number>,
  options?: UseCounterOptions,
): {
  count: Ref<number, MaybeRef<number>>
  inc: (delta?: number) => number
  dec: (delta?: number) => number
  get: () => number
  set: (val: number) => number
  reset: (val?: number) => number
}