Skip to content

docs: add note about setting up an alias to vue in project bundlers #3133

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

Merged
merged 9 commits into from
Apr 18, 2019

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Apr 18, 2019

Describe the PR

When users are encountering the error "$attr and $listeners is readonly", they will need to set up an alias to Vue in their bundler config file.

Adds reference to https://vuejs.org/v2/guide/installation.html#Runtime-Compiler-vs-Runtime-only in the getting started page.

Addresses #3040

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, fix typos, chore: fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

When users are encountering the error `"$attr and $listeners is readonly"`, they will need to set up an alias to Vue in their bundler config file.

Adds reference to https://vuejs.org/v2/guide/installation.html#Runtime-Compiler-vs-Runtime-only
@codecov
Copy link

codecov bot commented Apr 18, 2019

Codecov Report

Merging #3133 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #3133   +/-   ##
=======================================
  Coverage   99.14%   99.14%           
=======================================
  Files         212      212           
  Lines        3860     3860           
  Branches     1153     1153           
=======================================
  Hits         3827     3827           
  Misses         26       26           
  Partials        7        7

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b44e4d...d47184c. Read the comment docs.

@tmorehouse tmorehouse changed the title docs: Add note about setting up an alias to vue in project bundlers docs: add note about setting up an alias to vue in project bundlers Apr 18, 2019
@tmorehouse tmorehouse requested review from jacobmllr95 and pi0 April 18, 2019 12:56
@tmorehouse tmorehouse merged commit 610a48e into dev Apr 18, 2019
@tmorehouse tmorehouse deleted the tmorehouse/docs-info branch April 18, 2019 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants