v2.0.0-rc.0
Pre-release
Pre-release
After a long wait here it is, the first Release Candidate for vue-meta v2.0 which should resolve most outstanding issues. As v2
is mostly a refactor of v1
, there are not many breaking changes and we expect to release v2
soon
Breaking Change
- The behaviour of keys with
undefined
as value has changed:- In
v1
it would be rendered as a boolean attribute, but as boolean attributes are actually part of e.g. the html5 specifications this functionality has been removed - In
v2
it can be used to render child properties conditionally.
- In
See the docs for more information about boolean attribute handling and how to use child properties conditionally
Noteworthy Changes
- We now have a separate documentation website! https://vue-meta.nuxtjs.org
- The global mixin which vue-meta uses now only injects a
beforeCreate
lifecycle hook. Other lifecycle hooks will only be added when a component has a metaInfo property defined - When retrieving and merging the metaInfo in your app, component branches without any component which defines metaInfo are skipped
- A
refreshOnceOnNavigation
option has been added which usesvue-router
navigation guards to only trigger meta updates once after navigation. Also check theafterNavigation
callback which can be used to run some script that relies on update metadata (e.g. page tracking) - You have more control on which value is used when a parent and child define the same
vmid
. See the docs on special cases for more information
Migration Guide
If you want to help us test this release candidate, please follow these steps:
-
Manually update your vue-meta version
- E.g. update your package.json to read
"vue-meta": "2.0.0-rc.0"
(or use thenext
tag): - Run
npm install
oryarn install
- E.g. update your package.json to read
-
Change the boolean attributes you use to have a different value than
undefined
-
Test and please report any issues you experience!
Features
- add afterNavigation callback (97badf6)
- add amp as boolean attribute (b7ee040)
- add browser build without ssr code (2862a5b)
- add es build (56f0b61)
- add getOptions method (31e975d)
- add option to refresh once during navigation (8e21175)
- add pause/resume methods to pause updates (d237180)
- attr keys can have array values (01edc8c)
- child can indicate its content should be ignored (22e456c)
- child can indicate parent vmid to be removed (915fedf)
- export hasMetaInfo helper function (173b31d)
- major refactor, cleanup and jest tests (5d64d43)
- ts: update types for v2 (7b85ff2)
- render boolean attributes correctly (deea5cf)
- track branches which contain metaInfo components (f2e8eb5)
- use named exports to export helper functions (95c3b7d)
Bug Fixes
- add afterNavigation type (722786d)
- add inject stub for browser build (02e4094)
- add ts type for refresh once (5935cf3)
- dont call changed with explicit this (5ad6711)
- dont inline typeof definitions (5031acf)
- implement simply array polyfills (d38f81e)
- rollup paths (bfbd181)
- trigger meta refresh on page load (b824a27)