rigor789/vue-scrollto

Add docs for Vue 3 usage

Open

#380 opened on Oct 9, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (1,966 stars) (114 forks)batch import
enhancementhelp wanted

Description

Add usage sample to readme for Vue 3 - added in #371. For example in a cdn/browser usage:

const app = Vue.createApp({})
app.directive('scroll-to', VueScrollTo)
app.mount('#app')

Contributor guide

Tech stack
javascriptvue
Domain
documentationfrontend
Issue type
documentation
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
Vue 3 basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Examine the current README.md in the repository. Look at PR #371 (linked in the issue) to understand the Vue 3 changes. Add a code snippet similar to the one in the issue body, under an appropriate section. Ensure the example works with Vue 3's API.