vue-unique-id/types/vue.d.ts

Component and HTML unique id generation plugin for Vue.js

/**
 * Augment the typings of Vue.js
 */

import Vue from 'vue';

declare module 'vue/types/vue' {
  interface Vue {
    /**
     * Unique id of the component.
     */
    uid: string;

    /**
     * Generate a component-scoped unique HTML identifier.
     *
     * Example: $id('my-id') => 'uid-42-my-id'
     *
     * @param id id to scope
     */
    $id(id?: string): string;

    /**
     * Generate a component-scoped unique HTML identifier reference. Prepends '#' to the id generated
     * by the call $id(id).
     *
     * Example: $idRef('my-id') => '#uid-42-my-id'
     *
     * @param id id to scope
     */
    $idRef(id?: string): string;
  }
}

export interface PluginOptions {
  /**
   * Property name of the component's unique identifier. Change this if 'vm.uid' conflicts
   * with another plugin or your own props.
   */
  uidProperty: string;

  /**
   * Prefix to use when generating HTML ids. Change this to make your ids more unique on a
   * page that already uses or could use a similar naming scheme.
   */
  uidPrefix: string;
}