Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update en doc links to relative path #29

Merged
merged 3 commits into from
Nov 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/breaking-changes/async-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ const asyncComponent = defineAsyncComponent(
For more information on the usage of async components, see:

- [Guide: Async Components](https://vuejs.org/guide/components/async.html)
- [Migration build flag: `COMPONENT_ASYNC`](/migration-build.html#compat-configuration)
- [Migration build flag: `COMPONENT_ASYNC`](../migration-build.html#compat-configuration)
2 changes: 1 addition & 1 deletion src/breaking-changes/attribute-coercion.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ In 3.x, `null` or `undefined` should be used to explicitly remove an attribute.
</tbody>
</table>

[Migration build flags:](/migration-build.html#compat-configuration)
[Migration build flags:](../migration-build.html#compat-configuration)

- `ATTR_FALSE_VALUE`
- `ATTR_ENUMERATED_COERCION`
2 changes: 1 addition & 1 deletion src/breaking-changes/attrs-includes-class-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ when used like this:

In components that use `inheritAttrs: false`, make sure that styling still works as intended. If you previously relied on the special behavior of `class` and `style`, some visuals might be broken as these attributes might now be applied to another element.

[Migration build flag: `INSTANCE_ATTRS_CLASS_STYLE`](/migration-build.html#compat-configuration)
[Migration build flag: `INSTANCE_ATTRS_CLASS_STYLE`](../migration-build.html#compat-configuration)

## See also

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/children.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ In 3.x, the `$children` property is removed and no longer supported. Instead, if

## Migration Strategy

[Migration build flag: `INSTANCE_CHILDREN`](/migration-build.html#compat-configuration)
[Migration build flag: `INSTANCE_CHILDREN`](../migration-build.html#compat-configuration)
4 changes: 2 additions & 2 deletions src/breaking-changes/custom-directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ mounted(el, binding, vnode) {
```

:::warning
With [fragments](/new/fragments.html#overview) support, components can potentially have more than one root node. When applied to a multi-root component, a custom directive will be ignored and a warning will be logged.
With [fragments](../new/fragments.html#overview) support, components can potentially have more than one root node. When applied to a multi-root component, a custom directive will be ignored and a warning will be logged.
:::

## Migration Strategy

[Migration build flag: `CUSTOM_DIR`](/migration-build.html#compat-configuration)
[Migration build flag: `CUSTOM_DIR`](../migration-build.html#compat-configuration)
2 changes: 1 addition & 1 deletion src/breaking-changes/custom-elements-interop.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ In 3.0, we are limiting Vue's special treatment of the `is` attribute to the `<c
document.createElement('button', { is: 'plastic-button' })
```

[Migration build flag: `COMPILER_IS_ON_ELEMENT`](/migration-build.html#compat-configuration)
[Migration build flag: `COMPILER_IS_ON_ELEMENT`](../migration-build.html#compat-configuration)

## `vue:` Prefix for In-DOM Template Parsing Workarounds

Expand Down
4 changes: 2 additions & 2 deletions src/breaking-changes/data-option.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ In 3.0, the result will be:
}
```

[Migration build flag: `OPTIONS_DATA_FN`](/migration-build.html#compat-configuration)
[Migration build flag: `OPTIONS_DATA_FN`](../migration-build.html#compat-configuration)

## Migration Strategy

Expand All @@ -122,7 +122,7 @@ For users relying on the object declaration, we recommend:

For users relying on the deep merge behavior from mixins, we recommend refactoring your code to avoid such reliance altogether, since deep merges from mixins are very implicit and can make the code logic more difficult to understand and debug.

[Migration build flags:](/migration-build.html#compat-configuration)
[Migration build flags:](../migration-build.html#compat-configuration)

- `OPTIONS_DATA_FN`
- `OPTIONS_DATA_MERGE`
2 changes: 1 addition & 1 deletion src/breaking-changes/events-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ We removed `$on`, `$off` and `$once` methods from the instance completely. `$emi

## Migration Strategy

[Migration build flag: `INSTANCE_EVENT_EMITTER`](/migration-build.html#compat-configuration)
[Migration build flag: `INSTANCE_EVENT_EMITTER`](../migration-build.html#compat-configuration)

In Vue 3, it is no longer possible to use these APIs to listen to a component's own emitted events from within a component. There is no migration path for that use case.

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Using the example above, here is one example of how it could be implemented.

Instead of using filters, we recommend replacing them with computed properties or methods.

[Migration build flags:](/migration-build.html#compat-configuration)
[Migration build flags:](../migration-build.html#compat-configuration)

- `FILTERS`
- `COMPILER_FILTERS`
Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/functional-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ For more information on the usage of the new functional components and the chang

- [Migration: Render Functions](./render-function-api.html)
- [Guide: Render Functions](https://vuejs.org/guide/extras/render-function.html#render-functions-jsx)
- [Migration build flag: `COMPONENT_FUNCTIONAL`](/migration-build.html#compat-configuration)
- [Migration build flag: `COMPONENT_FUNCTIONAL`](../migration-build.html#compat-configuration)
10 changes: 5 additions & 5 deletions src/breaking-changes/global-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ In Vue 3.x, the "use production build" tip will only show up when using the "dev

For ES modules builds, since they are used with bundlers, and in most cases a CLI or boilerplate would have configured the production env properly, this tip will no longer show up.

[Migration build flag: `CONFIG_PRODUCTION_TIP`](/migration-build.html#compat-configuration)
[Migration build flag: `CONFIG_PRODUCTION_TIP`](../migration-build.html#compat-configuration)

### `config.ignoredElements` Is Now `config.compilerOptions.isCustomElement`

Expand All @@ -118,7 +118,7 @@ In Vue 3, the check of whether an element is a component or not has been moved t
- This will be a new top-level option in the Vue CLI config.
:::

[Migration build flag: `CONFIG_IGNORED_ELEMENTS`](/migration-build.html#compat-configuration)
[Migration build flag: `CONFIG_IGNORED_ELEMENTS`](../migration-build.html#compat-configuration)

### `Vue.prototype` Replaced by `config.globalProperties`

Expand All @@ -139,7 +139,7 @@ app.config.globalProperties.$http = () => {}

Using `provide` (discussed [below](#provide-inject)) should also be considered as an alternative to `globalProperties`.

[Migration build flag: `GLOBAL_PROTOTYPE`](/migration-build.html#compat-configuration)
[Migration build flag: `GLOBAL_PROTOTYPE`](../migration-build.html#compat-configuration)

### `Vue.extend` Removed

Expand Down Expand Up @@ -189,7 +189,7 @@ Note that although the return type of `defineComponent` is a constructor-like ty

In Vue 3, we strongly recommend favoring composition via [Composition API](https://vuejs.org/guide/reusability/composables.html) over inheritance and mixins. If for some reason you still need component inheritance, you can use the [`extends` option](https://vuejs.org/api/options-composition.html#extends) instead of `Vue.extend`.

[Migration build flag: `GLOBAL_EXTEND`](/migration-build.html#compat-configuration)
[Migration build flag: `GLOBAL_EXTEND`](../migration-build.html#compat-configuration)

### A Note for Plugin Authors

Expand Down Expand Up @@ -244,7 +244,7 @@ app.directive('focus', {
app.mount('#app')
```

[Migration build flag: `GLOBAL_MOUNT`](/migration-build.html#compat-configuration)
[Migration build flag: `GLOBAL_MOUNT`](../migration-build.html#compat-configuration)

## Provide / Inject

Expand Down
4 changes: 2 additions & 2 deletions src/breaking-changes/inline-template-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This feature will no longer be supported.

Most of the use cases for `inline-template` assumes a no-build-tool setup, where all templates are written directly inside the HTML page.

[Migration build flag: `COMPILER_INLINE_TEMPLATE`](/migration-build.html#compat-configuration)
[Migration build flag: `COMPILER_INLINE_TEMPLATE`](../migration-build.html#compat-configuration)

### Option #1: Use `<script>` tag

Expand Down Expand Up @@ -81,4 +81,4 @@ The child, instead of providing no template, should now render the default slot\
</template>
```

> - Note: In 3.x, slots can be rendered as the root with native [fragments](/new/fragments) support!
> - Note: In 3.x, slots can be rendered as the root with native [fragments](../new/fragments) support!
2 changes: 1 addition & 1 deletion src/breaking-changes/keycode-modifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The keys for some punctuation marks can just be included literally. e.g. For the

Limitations of the syntax prevent certain characters from being matched, such as `"`, `'`, `/`, `=`, `>`, and `.`. For those characters you should check `event.key` inside the listener instead.

[Migration build flags:](/migration-build.html#compat-configuration)
[Migration build flags:](../migration-build.html#compat-configuration)

- `CONFIG_KEY_CODES`
- `V_ON_KEYCODE_MODIFIER`
2 changes: 1 addition & 1 deletion src/breaking-changes/listeners-removed.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ If this component received an `id` attribute and a `v-on:close` listener, the `$

Remove all usages of `$listeners`.

[Migration build flag: `INSTANCE_LISTENERS`](/migration-build.html#compat-configuration)
[Migration build flag: `INSTANCE_LISTENERS`](../migration-build.html#compat-configuration)

## See also

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/mount-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ When this app is mounted to the page that has a `div` with `id="app"`, this will

## Migration Strategy

[Migration build flag: `GLOBAL_MOUNT_CONTAINER`](/migration-build.html#compat-configuration)
[Migration build flag: `GLOBAL_MOUNT_CONTAINER`](../migration-build.html#compat-configuration)

## See Also

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/props-default-this.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ export default {

## Migration Strategy

[Migration build flag: `PROPS_DEFAULT_THIS`](/migration-build.html#compat-configuration)
[Migration build flag: `PROPS_DEFAULT_THIS`](../migration-build.html#compat-configuration)
2 changes: 1 addition & 1 deletion src/breaking-changes/render-function-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ For more information, see [The Render Function Api Change RFC](https://github.co

## Migration Strategy

[Migration build flag: `RENDER_FUNCTION`](/migration-build.html#compat-configuration)
[Migration build flag: `RENDER_FUNCTION`](../migration-build.html#compat-configuration)

### Library Authors

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/slots-unification.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ A majority of the change has already been shipped in 2.6. As a result, the migra
1. Replace all `this.$scopedSlots` occurrences with `this.$slots` in 3.x.
2. Replace all occurrences of `this.$slots.mySlot` with `this.$slots.mySlot()`

[Migration build flag: `INSTANCE_SCOPED_SLOTS`](/migration-build.html#compat-configuration)
[Migration build flag: `INSTANCE_SCOPED_SLOTS`](../migration-build.html#compat-configuration)
4 changes: 2 additions & 2 deletions src/breaking-changes/transition-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In Vue 2, `<transition-group>`, like other custom components, needed a root elem

## 3.x Syntax

In Vue 3, we have [fragment support](/new/fragments.html), so components no longer _need_ a root node. Consequently, `<transition-group>` no longer renders one by default.
In Vue 3, we have [fragment support](../new/fragments.html), so components no longer _need_ a root node. Consequently, `<transition-group>` no longer renders one by default.

- If you already have the `tag` attribute defined in your Vue 2 code, like in the example above, everything will work as before
- If you didn't have one defined _and_ your styling or other behaviors relied on the presence of the `<span>` root element to work properly, simply add `tag="span"` to the `<transition-group>`:
Expand All @@ -37,7 +37,7 @@ In Vue 3, we have [fragment support](/new/fragments.html), so components no long

## Migration Strategy

[Migration build flag: `TRANSITION_GROUP_ROOT`](/migration-build.html#compat-configuration)
[Migration build flag: `TRANSITION_GROUP_ROOT`](../migration-build.html#compat-configuration)

## See also

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/v-bind.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ In 3x, if an element has both `v-bind="object"` and an identical individual attr

If you are relying on this override functionality for `v-bind`, we currently recommend ensuring that your `v-bind` attribute is defined before individual attributes.

[Migration build flag: `COMPILER_V_BIND_OBJECT_ORDER`](/migration-build.html#compat-configuration)
[Migration build flag: `COMPILER_V_BIND_OBJECT_ORDER`](../migration-build.html#compat-configuration)
2 changes: 1 addition & 1 deletion src/breaking-changes/v-if-v-for.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ It is recommended to avoid using both on the same element due to the syntax ambi

Rather than managing this at the template level, one method for accomplishing this is to create a computed property that filters out a list for the visible elements.

[Migration build flag: `COMPILER_V_IF_V_FOR_PRECEDENCE`](/migration-build.html#compat-configuration)
[Migration build flag: `COMPILER_V_IF_V_FOR_PRECEDENCE`](../migration-build.html#compat-configuration)

## See also

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/v-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ We recommend:
}
```

[Migration build flags:](/migration-build.html#compat-configuration)
[Migration build flags:](../migration-build.html#compat-configuration)

- `COMPONENT_V_MODEL`
- `COMPILER_V_BIND_SYNC`
Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/v-on-native-modifier-removed.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Consequently, Vue will now add all event listeners that are _not_ defined as com
- remove all instances of the `.native` modifier.
- ensure that all your components document their events with the `emits` option.

[Migration build flag: `COMPILER_V_ON_NATIVE`](/migration-build.html#compat-configuration)
[Migration build flag: `COMPILER_V_ON_NATIVE`](../migration-build.html#compat-configuration)

## See also

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/vnode-lifecycle-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In Vue 3, the event name is prefixed with `vue:`:

In most cases it should just require changing the prefix. The lifecycle hooks `beforeDestroy` and `destroyed` have been renamed to `beforeUnmount` and `unmounted` respectively, so the corresponding event names will also need to be updated.

[Migration build flags: `INSTANCE_EVENT_HOOKS`](/migration-build.html#compat-configuration)
[Migration build flags: `INSTANCE_EVENT_HOOKS`](../migration-build.html#compat-configuration)

## See Also

Expand Down
2 changes: 1 addition & 1 deletion src/breaking-changes/watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ watch: {

If you rely on watching array mutations, add the `deep` option to ensure that your callback is triggered correctly.

[Migration build flag: `WATCH_ARRAY`](/migration-build.html#compat-configuration)
[Migration build flag: `WATCH_ARRAY`](../migration-build.html#compat-configuration)
6 changes: 3 additions & 3 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Some of the new features to keep an eye on in Vue 3 include:
- [Composition API](https://vuejs.org/guide/extras/composition-api-faq.html)<span class="note">\*</span>
- [SFC Composition API Syntax Sugar (`<script setup>`)](https://vuejs.org/api/sfc-script-setup.html)<span class="note">\*</span>
- [Teleport](https://vuejs.org/guide/built-ins/teleport.html)
- [Fragments](/new/fragments.html)
- [Fragments](./new/fragments.html)
- [Emits Component Option](https://vuejs.org/api/options-state.html#emits)<span class="note">\*\*</span>
- [`createRenderer` API from `@vue/runtime-core`](https://vuejs.org/api/custom-renderer.html) to create custom renderers
- [SFC State-driven CSS Variables (`v-bind` in `<style>`)](https://vuejs.org/api/sfc-css-features.html#v-bind-in-css)<span class="note">\*</span>
Expand All @@ -108,11 +108,11 @@ Some of the new features to keep an eye on in Vue 3 include:

## Breaking Changes

Breaking changes between Vue 2 and Vue 3 are listed [here](/breaking-changes/).
Breaking changes between Vue 2 and Vue 3 are listed [here](./breaking-changes/).

## New Framework-level Recommendations

New framework-level recommendations are listed [here](/recommendations).
New framework-level recommendations are listed [here](./recommendations).

## Migration Build

Expand Down
Loading