Skip to content

⬅️ Back to Table of Contents

📄 useVModels

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 3

📚 Table of Contents

🛠️ File Location:

📂 packages/core/useVModels/index.ts

📦 Imports

Name Source
ToRefs vue
UseVModelOptions ../useVModel
useVModel ../useVModel

Functions

useVModels(props: P, emit: (name: Name, ...args: any[]) => void, options: UseVModelOptions<any, true>): ToRefs<P>

Shorthand for props v-model binding. Think like toRefs(props) but changes will also emit out.

Parameters:

  • props any: No description
  • emit any: No description
  • options any: No description

See: https://vueuse.org/useVModels

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc
/**
 * Shorthand for props v-model binding. Think like `toRefs(props)` but changes will also emit out.
 *
 * @see https://vueuse.org/useVModels
 * @param props
 * @param emit
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */
Code
export function useVModels<P extends object, Name extends string>(
  props: P,
  emit?: (name: Name, ...args: any[]) => void,
  options?: UseVModelOptions<any, true>,
): ToRefs<P>

Generated by Syntax Scribe