Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DappTokenAmount

description

This component displays a token amount and permits to differentiate between the decimals part of the amount, and the integer part as well as adding a limitation on the number of decimals that are displayed and also adding a currency suffix.

You can customize this component using custom HTML attributes as listed below.

Warning: This component serves as a base to display any amount and does not currently implement a protection against big numbers overflow. A second iteration of this component may implement these features and remove this comment.

example

Using the DappTokenAmount component

  <template>
    <DappTokenAmount
      :decimals="2"
      :currency="DHP"
      :value="1.234"
    />
  </template>



Parameters
param variant

The optional design variant (defaults to "primary").

param value

The amount value as a number (defaults to 0).

param decimals

The number of decimal places to display (defaults to 6).

param currency

The currency symbol (defaults to empty string).

param fade-decimals

Whether the decimal part should be faded or not (defaults to false).

since

v0.1.0

Hierarchy

  • Vue
    • DappTokenAmount

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DappTokenAmount(options?: ThisTypedComponentOptionsWithArrayProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, object, object, object, never, {}, ComponentOptionsMixin, ComponentOptionsMixin>): DappTokenAmount
  • new DappTokenAmount(options?: ThisTypedComponentOptionsWithRecordProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, object, object, object, object, {}, ComponentOptionsMixin, ComponentOptionsMixin>): DappTokenAmount
  • new DappTokenAmount(options?: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin>): DappTokenAmount

  • new with array props

    Parameters

    • Optional options: ThisTypedComponentOptionsWithArrayProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, object, object, object, never, {}, ComponentOptionsMixin, ComponentOptionsMixin>

    Returns DappTokenAmount

  • new with object props ideally, the return type should just contain Props, not Record<keyof Props, any>. But TS requires to have Base constructors with the same return type.

    Parameters

    • Optional options: ThisTypedComponentOptionsWithRecordProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, object, object, object, object, {}, ComponentOptionsMixin, ComponentOptionsMixin>

    Returns DappTokenAmount

  • new with no props

    Parameters

    • Optional options: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin>

    Returns DappTokenAmount

Properties

Readonly $attrs

$attrs: Record<string, string>

Readonly $children

$children: Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>[]

$createElement

$createElement: CreateElement

Readonly $data

$data: Record<string, any>

$delete

$delete: { (object: object, key: string | number): void; <T>(array: T[], key: number): void }

Type declaration

    • (object: object, key: string | number): void
    • <T>(array: T[], key: number): void

    • Parameters

      • object: object
      • key: string | number

      Returns void

    • Type Parameters

      • T

      Parameters

      • array: T[]
      • key: number

      Returns void

Readonly $el

$el: Element

$emit

$emit: ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)

Type declaration

    • (event: string, ...args: any[]): Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>

    • Parameters

      • event: string
      • Rest ...args: any[]

      Returns Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>

Readonly $isServer

$isServer: boolean

Readonly $listeners

$listeners: Record<string, Function | Function[]>

$nextTick

$nextTick: { (): Promise<void>; <T>(this: T, cb: ((this: T, ...args: any[]) => any)): void; <T>(cb: ((this: T, ...args: any[]) => any), ctx: T): void }

Type declaration

    • (): Promise<void>
    • <T>(this: T, cb: ((this: T, ...args: any[]) => any)): void
    • <T>(cb: ((this: T, ...args: any[]) => any), ctx: T): void

    • Returns Promise<void>

    • Type Parameters

      • T

      Parameters

      • this: T
      • cb: ((this: T, ...args: any[]) => any)
          • (this: T, ...args: any[]): any

          • Parameters

            • this: T
            • Rest ...args: any[]

            Returns any

      Returns void

    • Type Parameters

      • T

      Parameters

      • cb: ((this: T, ...args: any[]) => any)
          • (this: T, ...args: any[]): any

          • Parameters

            • this: T
            • Rest ...args: any[]

            Returns any

      • ctx: T

      Returns void

Readonly $options

$options: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin>

Readonly $parent

$parent: null | Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>

Readonly $props

$props: Record<string, any>

Readonly $refs

$refs: {}

Type declaration

  • [key: string]: NeverFallback<Instance, Vue> | Vue | Element | (NeverFallback<Instance, Vue> | Vue | Element)[] | undefined

Readonly $root

$root: Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>

Readonly $scopedSlots

$scopedSlots: {}

Type declaration

  • [key: string]: NormalizedScopedSlot | undefined

$set

$set: { <T>(object: object, key: string | number, value: T): T; <T>(array: T[], key: number, value: T): T }

Type declaration

    • <T>(object: object, key: string | number, value: T): T
    • <T>(array: T[], key: number, value: T): T

    • Type Parameters

      • T

      Parameters

      • object: object
      • key: string | number
      • value: T

      Returns T

    • Type Parameters

      • T

      Parameters

      • array: T[]
      • key: number
      • value: T

      Returns T

Readonly $slots

$slots: {}

Type declaration

  • [key: string]: VNode[] | undefined

Readonly $ssrContext

$ssrContext: any

Readonly $vnode

$vnode: VNode

Protected Optional currency

currency?: string

The currency symbol (defaults to empty string).

access

protected

var

{string}

Protected Optional decimals

decimals?: number

The number of decimal places to display (defaults to 6).

access

protected

var

{number}

Optional fadeDecimals

fadeDecimals?: boolean

Holds whether the decimal part should be faded or not (defaults to false).

access

protected

var

{boolean}

Protected Optional value

value?: number

The amount value as a number (defaults to 0).

access

protected

var

{number}

Protected Optional variant

variant?: Variant

The optional design variant (defaults to "primary").

access

protected

var

{Variant}

Static config

config: VueConfiguration

Static util

util: { warn: any }

Type declaration

  • warn:function
    • warn(msg: string, vm?: CombinedVueInstance<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, object, object, object, Record<never, any>, {}, ComponentOptionsMixin, ComponentOptionsMixin, OptionTypesType<{}, {}, {}, {}, {}, {}>>): void

    • Parameters

      • msg: string
      • Optional vm: CombinedVueInstance<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, object, object, object, Record<never, any>, {}, ComponentOptionsMixin, ComponentOptionsMixin, OptionTypesType<{}, {}, {}, {}, {}, {}>>

      Returns void

Static version

version: string

Accessors

Protected amount

  • get amount(): number

fractionalPart

  • get fractionalPart(): string

  • Getter to retrieve only the decimal part of an amount. It uses the toLocaleString() method to format the number according to locale settings.

    The integer part is removed from the result.

    access

    public

    Returns string

integerPart

  • get integerPart(): string

Methods

$destroy

  • $destroy(): void

  • Returns void

$forceUpdate

  • $forceUpdate(): void

  • Returns void

$mount

  • $mount(elementOrSelector?: string | Element, hydrating?: boolean): DappTokenAmount

  • Parameters

    • Optional elementOrSelector: string | Element
    • Optional hydrating: boolean

    Returns DappTokenAmount

$off

  • Parameters

    • Optional event: string | string[]
    • Optional callback: Function

    Returns DappTokenAmount

$on

  • Parameters

    • event: string | string[]
    • callback: Function

    Returns DappTokenAmount

$once

  • Parameters

    • event: string | string[]
    • callback: Function

    Returns DappTokenAmount

$watch

  • $watch(expOrFn: string, callback: ((this: DappTokenAmount, n: any, o: any) => void), options?: WatchOptions): (() => void)
  • $watch<T>(expOrFn: ((this: DappTokenAmount) => T), callback: ((this: DappTokenAmount, n: T, o: T) => void), options?: WatchOptions): (() => void)

  • Parameters

    Returns (() => void)

      • (): void

      • Returns void

  • Type Parameters

    • T

    Parameters

    Returns (() => void)

      • (): void

      • Returns void

Static compile

  • compile(template: string): { staticRenderFns: (() => VNode)[]; render: any }

  • Parameters

    • template: string

    Returns { staticRenderFns: (() => VNode)[]; render: any }

    • staticRenderFns: (() => VNode)[]
    • render:function
      • render(createElement: any): VNode

      • Parameters

        • createElement: any

        Returns VNode

Static component

  • component(id: string): VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>
  • component<VC>(id: string, constructor: VC): VC
  • component<Data, Methods, Computed, Props, SetupBindings>(id: string, definition: AsyncComponent<Data, Methods, Computed, Props, {}>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, ComponentOptionsMixin, ComponentOptionsMixin>
  • component<Data, Methods, Computed, PropNames, SetupBindings, Mixin, Extends>(id: string, definition?: ThisTypedComponentOptionsWithArrayProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, PropNames, SetupBindings, Mixin, Extends>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Record<PropNames, any>, SetupBindings, Mixin, Extends>
  • component<Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>(id: string, definition?: ThisTypedComponentOptionsWithRecordProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, ComponentOptionsMixin, ComponentOptionsMixin>
  • component<PropNames>(id: string, definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Record<PropNames, any>, {}, ComponentOptionsMixin, ComponentOptionsMixin>
  • component<Props>(id: string, definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Props, {}, ComponentOptionsMixin, ComponentOptionsMixin>
  • component(id: string, definition?: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin>
  • component<T>(id: string, definition?: T): T

  • Parameters

    • id: string

    Returns VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>

  • Type Parameters

    • VC extends VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, VC>

    Parameters

    • id: string
    • constructor: VC

    Returns VC

  • Type Parameters

    • Data

    • Methods

    • Computed

    • Props

    • SetupBindings

    Parameters

    • id: string
    • definition: AsyncComponent<Data, Methods, Computed, Props, {}>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, ComponentOptionsMixin, ComponentOptionsMixin>

  • Type Parameters

    • Data

    • Methods

    • Computed

    • PropNames extends string = never

    • SetupBindings = {}

    • Mixin extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Mixin> = ComponentOptionsMixin

    • Extends extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Extends> = ComponentOptionsMixin

    Parameters

    • id: string
    • Optional definition: ThisTypedComponentOptionsWithArrayProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, PropNames, SetupBindings, Mixin, Extends>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Record<PropNames, any>, SetupBindings, Mixin, Extends>

  • Type Parameters

    • Data

    • Methods

    • Computed

    • Props

    • SetupBindings

    • Mixin extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Mixin> = ComponentOptionsMixin

    • Extends extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Extends> = ComponentOptionsMixin

    Parameters

    • id: string
    • Optional definition: ThisTypedComponentOptionsWithRecordProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, ComponentOptionsMixin, ComponentOptionsMixin>

  • Type Parameters

    • PropNames extends string

    Parameters

    • id: string
    • definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Record<PropNames, any>, {}, ComponentOptionsMixin, ComponentOptionsMixin>

  • Type Parameters

    • Props

    Parameters

    • id: string
    • definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Props, {}, ComponentOptionsMixin, ComponentOptionsMixin>

  • Parameters

    • id: string
    • Optional definition: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin>

  • Type Parameters

    • T extends ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions> & ComponentOptionsBase<Readonly<any>, any, any, any, any, any, any, any, string, {} | {}, T> & { props: any }

    Parameters

    • id: string
    • Optional definition: T

    Returns T

Static delete

  • delete(object: object, key: string | number): void
  • delete<T>(array: T[], key: number): void

  • Parameters

    • object: object
    • key: string | number

    Returns void

  • Type Parameters

    • T

    Parameters

    • array: T[]
    • key: number

    Returns void

Static directive

  • directive(id: string, definition?: DirectiveOptions | DirectiveFunction): DirectiveOptions
  • directive(id: string, definition?: Directive<any, any>): ObjectDirective<any, any>

  • Parameters

    • id: string
    • Optional definition: DirectiveOptions | DirectiveFunction

    Returns DirectiveOptions

  • Parameters

    • id: string
    • Optional definition: Directive<any, any>

    Returns ObjectDirective<any, any>

Static extend

  • extend<Data, Methods, Computed, PropNames, SetupBindings, Mixin, Extends>(options?: ThisTypedComponentOptionsWithArrayProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, PropNames, SetupBindings, Mixin, Extends>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Record<PropNames, any>, SetupBindings, Mixin, Extends>
  • extend<Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>(options?: ThisTypedComponentOptionsWithRecordProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>
  • extend<PropNames>(definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Record<PropNames, any>, {}, ComponentOptionsMixin, ComponentOptionsMixin>
  • extend<Props>(definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Props, {}, ComponentOptionsMixin, ComponentOptionsMixin>
  • extend(options?: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin>): ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin>

  • extend with array props

    Type Parameters

    • Data

    • Methods

    • Computed

    • PropNames extends string = never

    • SetupBindings = {}

    • Mixin extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Mixin> = ComponentOptionsMixin

    • Extends extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Extends> = ComponentOptionsMixin

    Parameters

    • Optional options: ThisTypedComponentOptionsWithArrayProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, PropNames, SetupBindings, Mixin, Extends>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Record<PropNames, any>, SetupBindings, Mixin, Extends>

  • extend with object props

    Type Parameters

    • Data

    • Methods

    • Computed

    • Props

    • SetupBindings = {}

    • Mixin extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Mixin> = ComponentOptionsMixin

    • Extends extends ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any, Extends> = ComponentOptionsMixin

    Parameters

    • Optional options: ThisTypedComponentOptionsWithRecordProps<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, Data, Methods, Computed, Props, SetupBindings, Mixin, Extends>

  • extend with functional + array props

    Type Parameters

    • PropNames extends string = never

    Parameters

    • definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Record<PropNames, any>, {}, ComponentOptionsMixin, ComponentOptionsMixin>

  • extend with functional + object props

    Type Parameters

    • Props

    Parameters

    • definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, Props, {}, ComponentOptionsMixin, ComponentOptionsMixin>

  • extend with no props

    Parameters

    • Optional options: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin>

    Returns ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin>

Static filter

  • filter(id: string, definition?: Function): Function

  • Parameters

    • id: string
    • Optional definition: Function

    Returns Function

Static mixin

  • mixin(mixin: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin> | VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>): VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>

  • Parameters

    • mixin: ComponentOptions<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>, DefaultData<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultMethods<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps, {}, ComponentOptionsMixin, ComponentOptionsMixin> | VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>

    Returns VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>

Static nextTick

  • nextTick<T>(callback: ((this: T) => void), context?: T): void
  • nextTick(): Promise<void>

  • Type Parameters

    • T

    Parameters

    • callback: ((this: T) => void)
        • (this: T): void

        • Parameters

          • this: T

          Returns void

    • Optional context: T

    Returns void

  • Returns Promise<void>

Static observable

  • observable<T>(obj: T): T

  • Type Parameters

    • T

    Parameters

    • obj: T

    Returns T

Static set

  • set<T>(object: object, key: string | number, value: T): T
  • set<T>(array: T[], key: number, value: T): T

  • Type Parameters

    • T

    Parameters

    • object: object
    • key: string | number
    • value: T

    Returns T

  • Type Parameters

    • T

    Parameters

    • array: T[]
    • key: number
    • value: T

    Returns T

Static use

  • use<T>(plugin: PluginObject<T> | PluginFunction<T>, options?: T): VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>
  • use(plugin: PluginObject<any> | PluginFunction<any>, ...options: any[]): VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>

  • Type Parameters

    • T

    Parameters

    • plugin: PluginObject<T> | PluginFunction<T>
    • Optional options: T

    Returns VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>

  • Parameters

    • plugin: PluginObject<any> | PluginFunction<any>
    • Rest ...options: any[]

    Returns VueConstructor<Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ((event: string, ...args: any[]) => Vue<Record<string, any>, Record<string, any>, never, never, ...>)>)>>

Generated using TypeDoc