rigor789/vue-scrollto

using this.$scrollTo in nuxt / typescript

Ouverte

#321 ouverte le 11 juil. 2020

Voir sur GitHub
 (2 commentaires) (4 réactions) (0 personne assignée)JavaScript (114 forks)batch import
help wantednuxt

Métriques du dépôt

Stars
 (1 966 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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)"

Guide contributeur

Direction de recherche
Le problème est que TypeScript ne parvient pas à trouver la propriété `$scrollTo` sur les instances Vue car l'augmentation de types du plugin n'est pas automatiquement reconnue dans Nuxt. L'utilisateur a découvert qu'importer manuellement 'vue scrollto' dans un fichier global.d.ts résout l'erreur. Pour corriger cela, le package devrait exporter une déclaration de type qui augmente le module Vue pour une utilisation avec Nuxt. Examinez les définitions de types du plugin (probablement dans `vue scrollto/types/index.d.ts`) et envisagez d'ajouter une augmentation de type spécifique à Nuxt ou de la documentation. Vérifiez s'il existe des PR ou des commentaires existants traitant de ce problème.
Stack technique
vuetypescriptnuxt
Domaine
frontend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScriptVue
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70