Skip to content

Commit 453dfda

Browse files
committed
feat(docs): update vue links (since v3 is now default/latest version)
1 parent 656a42d commit 453dfda

File tree

10 files changed

+19
-20
lines changed

10 files changed

+19
-20
lines changed

docs/src/pages/app-extensions/tips-and-tricks/provide-a-directive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ import MyDirective from '../directive/MyDirective.js'
7575
// We globally register our directive with Vue;
7676
// Remember that all directives in Vue will start with 'v-'
7777
// but that should not be part of your directive name
78-
// https://v3.vuejs.org/guide/custom-directive.html#custom-directives
78+
// https://vuejs.org/guide/custom-directive.html#custom-directives
7979
// 'my-directive' will be used as 'v-my-directive'
8080
export default ({ app }) => {
8181
app.directive('my-directive', MyDirective)

docs/src/pages/contribution-guide/contribution-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Over time we consolidated a set of rules which we follow and following them will
126126
- Capitalize titles, see [How to Use Capitalize My Title](https://capitalizemytitle.com/).
127127
- Use the present tense.
128128
- Be concise, avoid text / code duplication.
129-
- Link to the external sources which are used as master information sources and are usually updated more frequently, like [Mozilla MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript), [Vue.js API](https://v3.vuejs.org/api/) rather than compiled tutorials which tend to be outdated soon.
129+
- Link to the external sources which are used as master information sources and are usually updated more frequently, like [Mozilla MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript), [Vue.js API](https://vuejs.org/api/) rather than compiled tutorials which tend to be outdated soon.
130130
- Do the proofreading before opening a PR
131131
- Do not repeat texts from other sources, but keep only things which are relevant and shows in a context Quasar specific features
132132
- Use official names. For example use `Firebase` instead of `firebase`

docs/src/pages/introduction-to-quasar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Quasar comes equipped with over 40 language packs out of the box. On top of that
114114
And finally, it’s worth mentioning the significant amount of time taken to write great, bloat-free, focused and complete documentation so that developers can quickly pick up Quasar. We put special effort into our documentation to make sure there is no confusion.
115115

116116
## Underlying technologies
117-
[Vue](https://v3.vuejs.org/), [Node.js](https://nodejs.org/), [Webpack](https://webpack.js.org/), [Cordova](https://cordova.apache.org/), [Capacitor](https://capacitor.ionicframework.com), [Electron](https://electronjs.org/).
117+
[Vue](https://vuejs.org/), [Node.js](https://nodejs.org/), [Webpack](https://webpack.js.org/), [Cordova](https://cordova.apache.org/), [Capacitor](https://capacitor.ionicframework.com), [Electron](https://electronjs.org/).
118118

119119
Except for Vue, which only takes half a day to pick up and will change your life forever, there is no requirement for you to know the other technologies. They are all integrated and configured in Quasar for you.
120120

docs/src/pages/options/animations.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Animations
33
desc: Helper CSS animations supplied by Animate.css for a Quasar app.
44
---
55

6-
CSS Transitions can be handled by the [Vue Transition Component](https://v3.vuejs.org/guide/transitions-overview.html). The transitions are used for entering (appearing) or leaving (disappearing) animations.
6+
CSS Transitions can be handled by the [Vue Transition Component](https://vuejs.org/guide/transitions-overview.html). The transitions are used for entering (appearing) or leaving (disappearing) animations.
77

88
However, Quasar can supply a big list of ready to use CSS animations. The animation effects are borrowed from [Animate.css](https://animate.style/). So there are 80+ animation types available for you to use out of the box. Check the list either on Animate.css website or on the demo available for this page.
99

10-
> Please refer to [Vue](https://v3.vuejs.org/api/built-in-components.html#transition) documentation for learning on how to use the Vue supplied `<transition>` component.
10+
> Please refer to [Vue](https://vuejs.org/api/built-in-components.html#transition) documentation for learning on how to use the Vue supplied `<transition>` component.
1111
1212
## Installation
1313
Edit `/quasar.conf.js`.
@@ -88,4 +88,3 @@ Please note some things in the above example:
8888
1. Note `<transition-group>` instead of `<transition>`.
8989
2. The components and DOM elements must be keyed, like `key="text"` or `key="email-button"` in the example above.
9090
3. Both examples above have the Boolean property `appear` specified, which makes the entering animation kick in right after component(s) have been rendered. This property is optional.
91-

docs/src/pages/quasar-cli/lazy-loading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We'll cover how you can lazy load / code split parts of your app so that they ar
1010
It's normal to use the Vue Router calling static components as below.
1111

1212
::: warning
13-
Quasar documentation assumes you are already familiar with [Vue Router](https://github.com/vuejs/vue-router-next). Below it's described only the basics of how to make use of it in a Quasar CLI project. For the full list of its features please visit the [Vue Router documentation](https://next.router.vuejs.org/).
13+
Quasar documentation assumes you are already familiar with [Vue Router](https://github.com/vuejs/vue-router). Below it's described only the basics of how to make use of it in a Quasar CLI project. For the full list of its features please visit the [Vue Router documentation](https://router.vuejs.org/).
1414
:::
1515

1616
```js

docs/src/pages/quasar-cli/linter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Further extension of one of the Eslint setups above can be made. Your project wi
2020

2121
```js
2222
extends: [
23-
// https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention
23+
// https://eslint.vuejs.org/rules/#priority-a-essential-error-prevention-for-vue-js-3-x
2424
// consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules.
2525
'plugin:vue/strongly-recommended'
2626
]
@@ -43,7 +43,7 @@ The linting rules can be removed, changed, or added. Notice some things:
4343
* Some rules are for the Standard, Airbnb or Prettier standards (whichever you chose when project was created). Example: 'brace-style'.
4444
* Some rules are for eslint-plugin-vue. Example: 'vue/max-attributes-per-line'.
4545

46-
You can add/remove/change rules by first visiting https://eslint.org/docs/rules/ or https://github.com/vuejs/eslint-plugin-vue.
46+
You can add/remove/change rules by first visiting [https://eslint.org/docs/rules/](https://eslint.org/docs/rules/) or [https://eslint.vuejs.org/rules](https://eslint.vuejs.org/rules).
4747

4848
Example of ESLint rules below:
4949
```js

docs/src/pages/quasar-cli/routing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You'll notice that your Quasar project contains a `/src/router` folder. This hol
99
* "/src/router/routes.js" holds the routes of your website/app
1010

1111
::: warning
12-
Quasar documentation assumes you are already familiar with [Vue Router](https://github.com/vuejs/vue-router-next). Below it's described only the basics of how to make use of it in a Quasar CLI project. For the full list of its features please visit the [Vue Router documentation](https://next.router.vuejs.org/).
12+
Quasar documentation assumes you are already familiar with [Vue Router](https://github.com/vuejs/vue-router). Below it's described only the basics of how to make use of it in a Quasar CLI project. For the full list of its features please visit the [Vue Router documentation](https://router.vuejs.org/).
1313
:::
1414

1515
The `/src/router/routes.js` needs to import your website/app's Pages and Layouts. Read more on [Routing with Layouts and Pages](/layout/routing-with-layouts-and-pages) documentation page.

docs/src/pages/security/dos-and-donts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We have collected some best practices for those of you new to the security theat
1212

1313
### User Input and the Dangers of v-html
1414

15-
The `v-html` directive is a wonderful way to programmatically render markup, but even the Vue docs come with [this warning](https://v3.vuejs.org/api/directives.html#v-html):
15+
The `v-html` directive is a wonderful way to programmatically render markup, but even the Vue docs come with [this warning](https://vuejs.org/api/directives.html#v-html):
1616
> "Dynamically rendering arbitrary HTML on your website can be very dangerous because it can easily lead to XSS vulnerabilities. Only use HTML interpolation on trusted content and never on user-provided content."
1717
1818
If you don't know what that means, take a quick look at what OWASP has to say about [XSS (aka cross-site scripting)](https://owasp.org/www-community/attacks/xss/).

docs/src/pages/start/how-to-use-vue.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: How To Use Vue
33
desc: Quick tutorial about Vue principles and how to use it with Quasar.
44
---
5-
Before you begin with Quasar, it is a good idea to get acquainted with ES6 and have a fairly good knowledge about how Vue 3 works. ([Quick overview of ES6](https://github.com/lukehoban/es6features) and [ES6 complete list of features](http://es6-features.org/#Constants) -- don't worry, you don't need to understand ALL of ES6). For devs experienced with reactive UIs, the [Vue 3 documentation](https://v3.vuejs.org/) itself takes a half-day at most to read top-to-bottom and will help you understand how Quasar components can be used and configured.
5+
Before you begin with Quasar, it is a good idea to get acquainted with ES6 and have a fairly good knowledge about how Vue 3 works. ([Quick overview of ES6](https://github.com/lukehoban/es6features) and [ES6 complete list of features](http://es6-features.org/#Constants) -- don't worry, you don't need to understand ALL of ES6). For devs experienced with reactive UIs, the [Vue 3 documentation](https://vuejs.org/) itself takes a half-day at most to read top-to-bottom and will help you understand how Quasar components can be used and configured.
66

77
::: tip
88
If you are a total beginner to Vue and reactive UI libraries and want a good tutorial, we recommend you take a look at [Vue and Quasar video tutorials](/video-tutorials).
@@ -57,7 +57,7 @@ You can specify you want your chosen preprocessor to handle the CSS code that yo
5757

5858
## Using Quasar Directives
5959

60-
Quasar comes with a few custom [Vue Directives](https://v3.vuejs.org/guide/custom-directive.html). These directives can be applied on almost any DOM element or Component.
60+
Quasar comes with a few custom [Vue Directives](https://vuejs.org/guide/custom-directive.html). These directives can be applied on almost any DOM element or Component.
6161

6262
Example of a Quasar directive:
6363

docs/src/pages/start/upgrade-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -286,13 +286,13 @@ You'll need to edit src/App.vue and remove the wrapper `<div id="q-app">`. You d
286286
For Quasar CLI projects, you don't need to manually install/upgrade the `vue` package as "@quasar/app" v3 is already supplying the correct version of Vue for you.
287287
:::
288288

289-
Since you will also switch to [Vue 3](https://v3.vuejs.org), it's best that you also take a look at its [migration guide](https://v3.vuejs.org/guide/migration/introduction.html) **after** finishing reading this migration guide.
289+
Since you will also switch to [Vue 3](https://vuejs.org), it's best that you also take a look at its [migration guide](https://vuejs.org/guide/migration/introduction.html) **after** finishing reading this migration guide.
290290

291-
If you're using .vue files, you'll most likely have a fairly easy transition because 1) vue-loader (supplied by `@quasar/app`) is the one parsing the [SFC syntax](https://v3.vuejs.org/guide/single-file-component.html) and instructing Vue 3 on what to do and 2) you can still use the Options API (although we recommend that you convert to the newer and better [Composition API](https://v3.vuejs.org/guide/composition-api-introduction.html)).
291+
If you're using .vue files, you'll most likely have a fairly easy transition because 1) vue-loader (supplied by `@quasar/app`) is the one parsing the [SFC syntax](https://vuejs.org/guide/single-file-component.html) and instructing Vue 3 on what to do and 2) you can still use the Options API (although we recommend that you convert to the newer and better [Composition API](https://vuejs.org/guide/composition-api-introduction.html)).
292292

293293
We suggest that you first convert your project to Quasar v2 while maintaining Options API (because your components are already in Options API form and you probably want to ensure everything is working first). After this transition, you can convert all your Vue components to Composition API, but in no way is this a requirement.
294294

295-
Along with Vue3, there is a new major version of [Vue Router v4](https://next.router.vuejs.org), which has its own [breaking changes](https://next.router.vuejs.org/guide/migration/) you should be aware of. There's also the new [Vuex v4](https://vuex.vuejs.org/) too.
295+
Along with Vue3, there is a new major version of [Vue Router v4](https://router.vuejs.org), which has its own [breaking changes](https://router.vuejs.org/guide/migration/) you should be aware of. There's also the new [Vuex v4](https://vuex.vuejs.org/) too.
296296

297297
#### Vue 3 breaking changes examples
298298

@@ -323,7 +323,7 @@ If you'd like to use the Vue.js Devtools with Vue 3, you'll need to replace your
323323
For Quasar CLI projects, you don't need to manually install/upgrade the `vue-router` package as "@quasar/app" v3 is already supplying the correct version of Vue Router for you.
324324
:::
325325

326-
This is a Vue 3 ecosystem upstream breaking change. Update src/router files to match Vue Router v4's API. Vue Router v4 comes with its own [breaking changes](https://next.router.vuejs.org/guide/migration/index.html). Especially note below how we are dealing with the 404 error.
326+
This is a Vue 3 ecosystem upstream breaking change. Update src/router files to match Vue Router v4's API. Vue Router v4 comes with its own [breaking changes](https://router.vuejs.org/guide/migration/index.html). Especially note below how we are dealing with the 404 error.
327327

328328
```js
329329
// default src/router/index.js content:
@@ -384,7 +384,7 @@ $ yarn add vuex@4
384384
$ npm install vuex@4
385385
```
386386

387-
This is a Vue 3 ecosystem upstream breaking change. You'll need to update src/store files to match Vuex v4's API. Notice the "createStore" import from vuex and its usage in an example below. For informative purposes: [Vuex migration to 4.0 from 3.x](https://next.vuex.vuejs.org/guide/migrating-to-4-0-from-3-x.html)
387+
This is a Vue 3 ecosystem upstream breaking change. You'll need to update src/store files to match Vuex v4's API. Notice the "createStore" import from vuex and its usage in an example below. For informative purposes: [Vuex migration to 4.0 from 3.x](https://vuex.vuejs.org/guide/migrating-to-4-0-from-3-x.html)
388388

389389
```js
390390
// default src/store/index.js content:
@@ -518,7 +518,7 @@ function onClick (e, go) {
518518

519519
#### QBreadcrumbsEl
520520

521-
Removed "append" prop because Vue Router v4 [has also dropped it](https://next.router.vuejs.org/guide/migration/index.html#removal-of-append-prop-in-router-link).
521+
Removed "append" prop because Vue Router v4 [has also dropped it](https://router.vuejs.org/guide/migration/index.html#removal-of-append-prop-in-router-link).
522522
Added "tag" and "ripple" properties.
523523

524524
#### QCarousel
@@ -551,7 +551,7 @@ Use "class" and "style" attributes instead of "content-class" / "content-style"
551551

552552
#### QExpansionItem
553553

554-
Removed the "append" property because Vue Router v4 [has also dropped it](https://next.router.vuejs.org/guide/migration/index.html#removal-of-append-prop-in-router-link).
554+
Removed the "append" property because Vue Router v4 [has also dropped it](https://router.vuejs.org/guide/migration/index.html#removal-of-append-prop-in-router-link).
555555

556556
#### (New) Connecting to QForm
557557

0 commit comments

Comments
 (0)