rigor789/vue-scrollto

using this.$scrollTo in nuxt / typescript

Open

#321 opened on Jul 11, 2020

View on GitHub
 (2 comments) (4 reactions) (0 assignees)JavaScript (1,966 stars) (114 forks)batch import
help wantednuxt

Description

There's an issue when using with nuxt (2.13.3) / typescript (@nuxt/types => 2.13.3)

If i don't import vue-scrollto inside my global.d.ts file:

import 'vue-scrollto'

Then using this.$scrollTo inside a component would complain about:

"Property '$scrollTo' does not exist on type 'CombinedVueInstance<Vue, Data, { setActive(index: number, id: number): void; findArticles: ((this: any, val: string) => Promise) & Cancelable; hideResults(): void; showArticle(articleId: number, categoryId: number): Promise<...>; }, unknown, Readonly<...>>'.Vetur(2339)"

Contributor guide

Tech stack
vuetypescriptnuxt
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of NuxtTypeScript setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue is that TypeScript cannot find the `$scrollTo` property on Vue instances because the plugin's type augmentation is not being automatically recognized in Nuxt. The user found that manually importing 'vue scrollto' in a global.d.ts file resolves the error. To fix, the package should export a type declaration that augments Vue's module for Nuxt usage. Look into the plugin's type definitions (likely in `vue scrollto/types/index.d.ts`) and consider adding a Nuxt specific type augmentation or documentation. Check if there are any existing PRs or comments addressing this.