Skip to content

feat: add note on isCustomElement in runtime-only builds #779

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 1 commit into from
Jan 6, 2021
Merged

feat: add note on isCustomElement in runtime-only builds #779

merged 1 commit into from
Jan 6, 2021

Conversation

Xenonym
Copy link
Contributor

@Xenonym Xenonym commented Jan 4, 2021

Description of Problem

The isCustomElement config option only applies when using the runtime compiler. Since most users will be using the runtime-only compiler (eg. via vue-loader or @vue/cli), they may attempt to configure this option by mistake (eg. vuejs/vue-next #2779).

Proposed Solution

Let's add a note that they may need to configure vue-loader's compilerOptions for custom elements to work properly.

Additional Information

The language used is taken from the migration guide.

The isCustomElement config option only applies when using the runtime
compiler.

Since most users will be using the runtime-only compiler (eg. via
vue-loader or @vue/cli), we should add a note that they may need to
configure vue-loader instead.
@Xenonym
Copy link
Contributor Author

Xenonym commented Jan 4, 2021

Hmm, I am not quite sure if it's an issue with my PR or the CI job that tags alert blocks - is it because I am not a member of the @vuejs org?

Copy link
Member

@NataliaTepluhina NataliaTepluhina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Xenonym thank you for adding this! The CI job fails to draw attention to the added tip block - we try to avoid having too many of them, but the current one seems to be justified for me

@NataliaTepluhina NataliaTepluhina merged commit 4b551fb into vuejs:master Jan 6, 2021
@Xenonym Xenonym deleted the enhancement/iscustomelement-add-runtime-caveat branch January 6, 2021 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants