Skip to content

Commit 1b65952

Browse files
MachinisteWebchrisvfritz
authored andcommitted
Version note standardization (vuejs#1025)
* - Change some `>=` to `+` for consistency with API and all others Vue documentations. Signed-off-by: Bruno Lesieur <bruno.lesieur@gmail.com> * Version adjutement Signed-off-by: Bruno Lesieur <bruno.lesieur@gmail.com> * 1. Keep New in 2.2.0 blockquotes for completely new sections, but add + (e.g. New in 2.2.0+) 2. Move to 2.2.0+, replacing >=2.2.0 3. Remove only (e.g. in 2.2.0+ only) Signed-off-by: Bruno Lesieur <bruno.lesieur@gmail.com> * Change before to below Signed-off-by: Bruno Lesieur <bruno.lesieur@gmail.com>
1 parent 46abc37 commit 1b65952

File tree

9 files changed

+43
-43
lines changed

9 files changed

+43
-43
lines changed

src/v2/api/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,15 @@ type: api
7979

8080
Assign a handler for uncaught errors during component render function and watchers. The handler gets called with the error and the Vue instance.
8181

82-
> In 2.2.0, this hook also captures errors in component lifecycle hooks. Also, when this hook is `undefined`, captured errors will be logged with `console.error` instead of crashing the app.
82+
> In 2.2.0+, this hook also captures errors in component lifecycle hooks. Also, when this hook is `undefined`, captured errors will be logged with `console.error` instead of crashing the app.
8383
84-
> In 2.4.0 this hook also captures errors thrown inside Vue custom event handlers.
84+
> In 2.4.0+ this hook also captures errors thrown inside Vue custom event handlers.
8585
8686
> [Sentry](https://sentry.io), an error tracking service, provides [official integration](https://sentry.io/for/vue/) using this option.
8787
8888
### warnHandler
8989

90-
> New in 2.4.0
90+
> New in 2.4.0+
9191
9292
- **Type:** `Function`
9393

@@ -147,19 +147,19 @@ type: api
147147

148148
### performance
149149

150-
> New in 2.2.0
150+
> New in 2.2.0+
151151
152152
- **Type:** `boolean`
153153

154-
- **Default:** `false (from 2.2.3)`
154+
- **Default:** `false (from 2.2.3+)`
155155

156156
- **Usage**:
157157

158158
Set this to `true` to enable component init, compile, render and patch performance tracing in the browser devtool timeline. Only works in development mode and in browsers that support the [performance.mark](https://developer.mozilla.org/en-US/docs/Web/API/Performance/mark) API.
159159

160160
### productionTip
161161

162-
> New in 2.2.0
162+
> New in 2.2.0+
163163
164164
- **Type:** `boolean`
165165

@@ -229,7 +229,7 @@ type: api
229229
})
230230
```
231231

232-
> New in 2.1.0: returns a Promise if no callback is provided and Promise is supported in the execution environment.
232+
> New in 2.1.0+: returns a Promise if no callback is provided and Promise is supported in the execution environment.
233233
234234
- **See also:** [Async Update Queue](../guide/reactivity.html#Async-Update-Queue)
235235

@@ -677,7 +677,7 @@ if (version === 2) {
677677

678678
### renderError
679679

680-
> New in 2.2.0
680+
> New in 2.2.0+
681681
682682
- **Type:** `(createElement: () => VNode, error: Error) => VNode`
683683

@@ -928,7 +928,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
928928
929929
### provide / inject
930930
931-
> New in 2.2.0
931+
> New in 2.2.0+
932932
933933
- **Type:**
934934
- **provide:** `Object | () => Object`
@@ -983,7 +983,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
983983
}
984984
```
985985
986-
> The next 2 examples only work with Vue > 2.2.1. Below that version, injected values were resolved after the `props` and the `data` initialization.
986+
> The next 2 examples work with Vue 2.2.1+. Below that version, injected values were resolved after the `props` and the `data` initialization.
987987
988988
Using an injected value as the default for a prop:
989989
```js
@@ -1102,7 +1102,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
11021102
11031103
### inheritAttrs
11041104
1105-
> New in 2.4.0
1105+
> New in 2.4.0+
11061106
11071107
- **Type:** `boolean`
11081108
@@ -1114,7 +1114,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
11141114
11151115
### comments
11161116
1117-
> New in 2.4.0
1117+
> New in 2.4.0+
11181118
11191119
- **Type:** `boolean`
11201120
@@ -1138,7 +1138,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
11381138
11391139
### vm.$props
11401140
1141-
> New in 2.2.0
1141+
> New in 2.2.0+
11421142
11431143
- **Type:** `Object`
11441144
@@ -1257,7 +1257,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
12571257
12581258
### vm.$scopedSlots
12591259
1260-
> New in 2.1.0
1260+
> New in 2.1.0+
12611261
12621262
- **Type:** `{ [name: string]: props => VNode | Array<VNode> }`
12631263
@@ -1527,7 +1527,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
15271527
15281528
Defer the callback to be executed after the next DOM update cycle. Use it immediately after you've changed some data to wait for the DOM update. This is the same as the global `Vue.nextTick`, except that the callback's `this` context is automatically bound to the instance calling this method.
15291529
1530-
> New in 2.1.0: returns a Promise if no callback is provided and Promise is supported in the execution environment.
1530+
> New in 2.1.0+: returns a Promise if no callback is provided and Promise is supported in the execution environment.
15311531
15321532
- **Example:**
15331533
@@ -1653,7 +1653,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
16531653
16541654
### v-else-if
16551655
1656-
> New in 2.1.0
1656+
> New in 2.1.0+
16571657
16581658
- **Expects:** `any`
16591659
@@ -1743,7 +1743,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
17431743

17441744
Attaches an event listener to the element. The event type is denoted by the argument. The expression can either be a method name or an inline statement, or simply omitted when there are modifiers present.
17451745

1746-
Starting in `2.4.0`, `v-on` also supports binding to an object of event/listener pairs without an argument. Note when using the object syntax, it does not support any modifiers.
1746+
Starting in 2.4.0+, `v-on` also supports binding to an object of event/listener pairs without an argument. Note when using the object syntax, it does not support any modifiers.
17471747

17481748
When used on a normal element, it listens to **native DOM events** only. When used on a custom element component, it also listens to **custom events** emitted on that child component.
17491749

@@ -2185,7 +2185,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
21852185
21862186
When a component is toggled inside `<keep-alive>`, its `activated` and `deactivated` lifecycle hooks will be invoked accordingly.
21872187
2188-
> In 2.2.0 and above, `activated` and `deactivated` will fire for all nested components inside a `<keep-alive>` tree.
2188+
> In 2.2.0+ and above, `activated` and `deactivated` will fire for all nested components inside a `<keep-alive>` tree.
21892189
21902190
Primarily used with preserve component state or avoid re-rendering.
21912191
@@ -2214,7 +2214,7 @@ All lifecycle hooks automatically have their `this` context bound to the instanc
22142214
22152215
- **`include` and `exclude`**
22162216
2217-
> New in 2.1.0
2217+
> New in 2.1.0+
22182218
22192219
The `include` and `exclude` props allow components to be conditionally cached. Both props can be a comma-delimited string, a RegExp or an Array:
22202220

src/v2/guide/class-and-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ When you use a CSS property that requires [vendor prefixes](https://developer.mo
197197

198198
> 2.3.0+
199199
200-
Starting in 2.3 you can provide an array of multiple (prefixed) values to a style property, for example:
200+
Starting in 2.3.0+ you can provide an array of multiple (prefixed) values to a style property, for example:
201201

202202
``` html
203203
<div v-bind:style="{ display: ['-webkit-box', '-ms-flexbox', 'flex'] }">

src/v2/guide/components.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ In some cases we may need "two-way binding" for a prop - in fact, in Vue 1.x thi
581581

582582
This is why we removed the `.sync` modifier when 2.0 was released. However, we've found that there are indeed cases where it could be useful, especially when shipping reusable components. What we need to change is **making the code in the child that affects parent state more consistent and explicit.**
583583

584-
In 2.3 we re-introduced the `.sync` modifier for props, but this time it is just syntax sugar that automatically expands into an additional `v-on` listener:
584+
In 2.3.0+ we re-introduced the `.sync` modifier for props, but this time it is just syntax sugar that automatically expands into an additional `v-on` listener:
585585

586586
The following
587587

@@ -723,7 +723,7 @@ The implementation above is pretty naive though. For example, users are allowed
723723

724724
### Customizing Component `v-model`
725725

726-
> New in 2.2.0
726+
> New in 2.2.0+
727727
728728
By default, `v-model` on a component uses `value` as the prop and `input` as the event, but some input types such as checkboxes and radio buttons may want to use the `value` prop for a different purpose. Using the `model` option can avoid the conflict in such cases:
729729

@@ -935,7 +935,7 @@ The content distribution API is a very useful mechanism when designing component
935935

936936
### Scoped Slots
937937

938-
> New in 2.1.0
938+
> New in 2.1.0+
939939
940940
A scoped slot is a special type of slot that functions as a reusable template (that can be passed data to) instead of already-rendered-elements.
941941

@@ -1145,9 +1145,9 @@ new Vue({
11451145

11461146
### Advanced Async Components
11471147

1148-
> New in 2.3.0
1148+
> New in 2.3.0+
11491149
1150-
Starting in 2.3 the async component factory can also return an object of the following format:
1150+
Starting in 2.3.0+ the async component factory can also return an object of the following format:
11511151

11521152
``` js
11531153
const AsyncComp = () => ({

src/v2/guide/conditional.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ A `v-else` element must immediately follow a `v-if` or a `v-else-if` element - o
5757

5858
### `v-else-if`
5959

60-
> New in 2.1.0
60+
> New in 2.1.0+
6161
6262
The `v-else-if`, as the name suggests, serves as an "else if block" for `v-if`. It can also be chained multiple times:
6363

src/v2/guide/events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ To address this problem, Vue provides **event modifiers** for `v-on`. Recall tha
196196

197197
<p class="tip">Order matters when using modifiers because the relevant code is generated in the same order. Therefore using `@click.prevent.self` will prevent **all clicks** while `@click.self.prevent` will only prevent clicks on the element itself.</p>
198198

199-
> New in 2.1.4
199+
> New in 2.1.4+
200200
201201
``` html
202202
<!-- the click event will be triggered at most once -->
@@ -270,7 +270,7 @@ For example:
270270

271271
### Mouse Button Modifiers
272272

273-
> New in 2.2.0
273+
> New in 2.2.0+
274274
275275
- `.left`
276276
- `.right`

src/v2/guide/render-function.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ Vue.component('my-component', {
468468
})
469469
```
470470

471-
> Note: in versions <=2.3.0, the `props` option is required if you wish to accept props in a functional component. In 2.3.0+ you can omit the `props` option and all attributes found on the component node will be implicitly extracted as props.
471+
> Note: in versions before 2.3.0, the `props` option is required if you wish to accept props in a functional component. In 2.3.0+ you can omit the `props` option and all attributes found on the component node will be implicitly extracted as props.
472472
473473
Everything the component needs is passed through `context`, which is an object containing:
474474

src/v2/guide/syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Vue.js allows you to define filters that can be used to apply common text format
130130
<div v-bind:id="rawId | formatId"></div>
131131
```
132132

133-
<p class="tip">Vue 2.x filters can only be used inside mustache interpolations and `v-bind` expressions (the latter supported since 2.1.0), because filters are primarily designed for text transformation purposes. For more complex data transforms in other directives, you should use [Computed properties](computed.html) instead.</p>
133+
<p class="tip">Vue 2.x filters can only be used inside mustache interpolations and `v-bind` expressions (the latter supported in 2.1.0+), because filters are primarily designed for text transformation purposes. For more complex data transforms in other directives, you should use [Computed properties](computed.html) instead.</p>
134134

135135
The filter function always receives the expression's value as the first argument.
136136

src/v2/guide/transitions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ new Vue({
5050
.fade-enter-active, .fade-leave-active {
5151
transition: opacity .5s
5252
}
53-
.fade-enter, .fade-leave-to /* .fade-leave-active in <2.1.8 */ {
53+
.fade-enter, .fade-leave-to /* .fade-leave-active below version 2.1.8 */ {
5454
opacity: 0
5555
}
5656
```
@@ -98,13 +98,13 @@ There are six classes applied for enter/leave transitions.
9898

9999
2. `v-enter-active`: Active state for enter. Applied during the entire entering phase. Added before element is inserted, removed when transition/animation finishes. This class can be used to define the duration, delay and easing curve for the entering transition.
100100

101-
3. `v-enter-to`: **Only available in versions >=2.1.8.** Ending state for enter. Added one frame after element is inserted (at the same time `v-enter` is removed), removed when transition/animation finishes.
101+
3. `v-enter-to`: **Only available in versions 2.1.8+.** Ending state for enter. Added one frame after element is inserted (at the same time `v-enter` is removed), removed when transition/animation finishes.
102102

103103
4. `v-leave`: Starting state for leave. Added immediately when a leaving transition is triggered, removed after one frame.
104104

105105
5. `v-leave-active`: Active state for leave. Applied during the entire leaving phase. Added immediately when leave transition is triggered, removed when the transition/animation finishes. This class can be used to define the duration, delay and easing curve for the leaving transition.
106106

107-
6. `v-leave-to`: **Only available in versions >=2.1.8.** Ending state for leave. Added one frame after a leaving transition is triggered (at the same time `v-leave` is removed), removed when the transition/animation finishes.
107+
6. `v-leave-to`: **Only available in versions 2.1.8+.** Ending state for leave. Added one frame after a leaving transition is triggered (at the same time `v-leave` is removed), removed when the transition/animation finishes.
108108

109109
![Transition Diagram](/images/transition.png)
110110

@@ -146,7 +146,7 @@ new Vue({
146146
transition: all .8s cubic-bezier(1.0, 0.5, 0.8, 1.0);
147147
}
148148
.slide-fade-enter, .slide-fade-leave-to
149-
/* .slide-fade-leave-active for <2.1.8 */ {
149+
/* .slide-fade-leave-active below version 2.1.8 */ {
150150
transform: translateX(10px);
151151
opacity: 0;
152152
}
@@ -289,10 +289,10 @@ You can also specify custom transition classes by providing the following attrib
289289

290290
- `enter-class`
291291
- `enter-active-class`
292-
- `enter-to-class` (>= 2.1.8 only)
292+
- `enter-to-class` (2.1.8+)
293293
- `leave-class`
294294
- `leave-active-class`
295-
- `leave-to-class` (>= 2.1.8 only)
295+
- `leave-to-class` (2.1.8+)
296296

297297
These will override the conventional class names. This is especially useful when you want to combine Vue's transition system with an existing CSS animation library, such as [Animate.css](https://daneden.github.io/animate.css/).
298298

@@ -356,7 +356,7 @@ However, in some cases you may want to have both on the same element, for exampl
356356

357357
### Explicit Transition Durations
358358

359-
> New in 2.2.0
359+
> New in 2.2.0+
360360
361361
In most cases, Vue can automatically figure out when the transition has finished. By default, Vue waits for the first `transitionend` or `animationend` event on the root transition element. However, this may not always be desired - for example, we may have a choreographed transition sequence where some nested inner elements have a delayed transition or a longer transition duration than the root transition element.
362362

@@ -560,7 +560,7 @@ By default, this will use the transitions specified for entering and leaving. If
560560
<transition
561561
appear
562562
appear-class="custom-appear-class"
563-
appear-to-class="custom-appear-to-class" (>= 2.1.8 only)
563+
appear-to-class="custom-appear-to-class" (2.1.8+)
564564
appear-active-class="custom-appear-active-class"
565565
>
566566
<!-- ... -->
@@ -906,7 +906,7 @@ new Vue({
906906
transition: opacity .3s ease;
907907
}
908908
.component-fade-enter, .component-fade-leave-to
909-
/* .component-fade-leave-active for <2.1.8 */ {
909+
/* .component-fade-leave-active below version 2.1.8 */ {
910910
opacity: 0;
911911
}
912912
```
@@ -1002,7 +1002,7 @@ new Vue({
10021002
.list-enter-active, .list-leave-active {
10031003
transition: all 1s;
10041004
}
1005-
.list-enter, .list-leave-to /* .list-leave-active for <2.1.8 */ {
1005+
.list-enter, .list-leave-to /* .list-leave-active below version 2.1.8 */ {
10061006
opacity: 0;
10071007
transform: translateY(30px);
10081008
}
@@ -1178,7 +1178,7 @@ new Vue({
11781178
margin-right: 10px;
11791179
}
11801180
.list-complete-enter, .list-complete-leave-to
1181-
/* .list-complete-leave-active for <2.1.8 */ {
1181+
/* .list-complete-leave-active below version 2.1.8 */ {
11821182
opacity: 0;
11831183
transform: translateY(30px);
11841184
}

src/v2/guide/typescript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ type: guide
44
order: 25
55
---
66

7-
## Important 2.2 Change Notice for TS + webpack 2 users
7+
## Important 2.2.0+ Change Notice for TS + webpack 2 users
88

9-
In Vue 2.2 we introduced dist files exposed as ES modules, which will be used by default by webpack 2. Unfortunately, this introduced an unintentional breaking change because with TypeScript + webpack 2, `import Vue = require('vue')` will now return a synthetic ES module object instead of Vue itself.
9+
In Vue 2.2.0+ we introduced dist files exposed as ES modules, which will be used by default by webpack 2. Unfortunately, this introduced an unintentional breaking change because with TypeScript + webpack 2, `import Vue = require('vue')` will now return a synthetic ES module object instead of Vue itself.
1010

1111
We plan to move all official declarations to use ES-style exports in the future. Please see [Recommended Configuration](#Recommended-Configuration) below on a future-proof setup.
1212

0 commit comments

Comments
 (0)