vue-typed-refs

vue-typed-refs

TypeScript utility type for Vue.js $refs

Installation

Via NPM

$ npm i vue-typed-refs -D

Via Yarn

$ yarn add vue-typed-refs --dev

Usage

<template>
  <div>
    <input ref="input" />
    <your-awesome-component ref="component"></your-awesome-component>
    <div v-if="condition" ref="underVIfElement"></div>
  </div>
</template>

import Vue from 'vue'
import { WithRefs } from 'vue-typed-refs'
// import type { WithRefs } from 'vue-typed-refs' TypeScript 3.8+
import YourAwesomeComponent from 'path/to/your/awesome/component'

type Refs = {
  input: HTMLInputElement
  component: InstanceType<typeof YourAwesomeComponent>
  underVIfElement?: HTMLDivElement
}

export default (Vue as WithRefs<Refs>).extend({
  name: 'Component',
  methods: {
    foo() {
      this.$refs.input // HTMLInputElement
      this.$refs.component // InstanceType<typeof YourAwesomeComponent>
      this.$refs.underVIfElement // HTMLDivElement | undefined
    },
  },
})

// YourAwesomeExtendedComponent.vue
// ...

export default Vue.extend({
  // ...
  methods: {
    baz() {},
  },
  // ...
})

// ...
import YourAwesomeExtendedComponent from 'path/to/your/awewsome/extended/component'

export default (YourAwesomeExtendedComponent as WithRefs<
  Refs,
  typeof YourAwesomeExtendedComponent
>).extend({})

Motivation

If your project is written using TypeScript + Vue.js, likely your code contains a lot of as casting: (this.$refs.input as HTMLInputElement).focus() when deailing with $refs.

The most desperate ones even create a helper to access $refs doing as casting only once:

{
  // ...
  methods: {
    getInput() {
      return this.$refs.input as HTMLInputElement
    }
  }
  // ...
}

The library provides a convenient way to declare type of you $refs per component scope.

The idea was adopted from vue-class-component.

Tests

npm run test

Build

npm run build

License

MIT