Vue3 custom element prop type number is a string in production.

[SavkaTaras]

Vue version

3.3.4

Link to minimal reproduction

https://github.com/SavkaTaras/vue-cue-issues

Steps to reproduce

npm install
npm run build
npm run dev

What is expected?

We import vue component and the same custom element below.

The custom element typeof should be number. The sum of 5.5 + 0.5 should be 6.

What is actually happening?

Custom element typeof returns a string.
Sum is 5.50.5.

System Info

System:
    OS: macOS 13.5
    CPU: (12) x64 Apple M2 Pro
    Memory: 201.20 MB / 16.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 14.20.0 - /usr/local/bin/node
    Yarn: 1.22.19 - ~/.npm-global/bin/yarn
    npm: 6.14.17 - /usr/local/bin/npm
  Browsers:
    Chrome: 114.0.5735.289
    Safari: 16.6
  npmPackages:
    vue: 3.3.4 => 3.3.4

Any additional comments?

Hello vue team,
I hope you are doing well.

@baiwusanyu-c could you please take a look at this issue when you have a moment?

Thank you so much guys,
Taras

[baiwusanyu-c]

https://play.vuejs.org/#eNqNUk1v2zAM/SuELsmw1N5Q9GK4AbYgh+3QFduOuqQOnaqzPqCPLIPh/z7ScrwUyIbpJPI9Uo/i68UH54pjQlGJOjReuQgBY3JraZR21kfoYY+tMrhJIVq97VCjiSvw2MIArbcaFlS/mPkbq92UL0oOuD3BjTUhoxuE+2tNlwy+IeZlMhSZuVw0eNMQYbGamhCzLrNmUktBRO26XUSKAOrn9+u+Bx0OMAx1SdGYVcalCMcbbffY3UtBuBQZmvpD1VpLyF1xJwVUTztPwTsO1nU5caigLufnxErEQOO16lC8BGvoL3vuKAVzVYf+i4uKxpeighFhbNd19ufnMRd9wtU53zxj8+NK/iWcOCfFo8eA/ohSzFjc+QPGDG+/PeCJ7jNIo6aO2P8Av2KwXWKNmfYxmT3JvuCNaj+NG1bm8D1sTxFNOA/FQpk5jHwpaOO8o7+N/kfubXE71kkz0C+e3XLFjFyYHeS8dWE20CNHy6kzH1re/NL5xF8OK3hI+gn9NBGfrDYfWvN/l+Xr8Np/l+6r9+rI5iMt8JZbjxbk5GvfDL8Bw80h1w==

[baiwusanyu-c]

https://play.vuejs.org/#eNqNUk1v2zAM/SuELsmw1N5Q9BK4AbYgh+3QFduOuqQOnaqzPqCPLIPh/z7SctwUSIvqJPI9Uo/i68QX54pDQrEUVai9chECxuRW0ijtrI/QwQ4bZXCdQrR606JGExfgsYEeGm81zKh+NvHXVrsxX5QccHuCa2tCRtcIt5eazhn8QMzzZCgycz6r8aomwmwxNiFmVWbNpJaCiNq124gUAVSPn1ddBzrsoe+rkqIhq4xLEQ5X2u6wvZWCcCkyNPaHxloCboobKeBh6+n+ie+rqhwZRK/K6TGxEDHQcI3aF0/BGvrJjvtJwVzVov/hoqLhpVjCgDC2bVv79/uQiz7h4pSvH7H+cyH/FI6ck+LeY0B/QCkmLG79HmOGN7/u8Ej3CaRBU0vsN8CfGGybWGOmfU1mR7LPeIPab8N+ldn/DptjRBNOQ7FQZvYDXwraN2/otdGf5V4X10OdND394skrF6zIhdk/zlsXJvvcczQfO/Oh3U0vnU7853AJd0k/oB8n4pPV5kNrfndZvvYv3XfuvWqnDmw90gIfufVgQE6+9E3/H+jKIWM=

[baiwusanyu-c]

I can't seem to reproduce the problem in the playground

[baiwusanyu-c]

I reproduced the problem, he only appears in some specific syntax

<template>
	<div class="component-a">
		<p>foo value: {{ props.foo }}</p>
		<p>typeof foo: {{ typeof props.foo }}</p>
		<p>Sum: {{ props.valOne + props.valTwo }}</p>
		<!-- <ComponentB /> -->
	</div>
</template>

<script lang="ts" setup>

interface Props {
  foo?: number;
	valOne: number;
	valTwo: number;
}

const props = withDefaults(defineProps<Props>(), {
	foo: 1,
	valOne: 2.5,
	valTwo: 0.5,
});
</script>

[SavkaTaras]

I see what you did. Is it possible to test per these docs:

Props Default Values section:

https://vuejs.org/guide/typescript/composition-api.html#typing-component-props

Thank you

[SavkaTaras]

We really enjoy setting the type with defaults. When using as vue component, typescript provides some valuable suggestions. vue-tsc helps during the type-check command. But when compiling to custom element, it doesn't seem to work.

Sum: {{ props.valOne + props.valTwo }}

only works correctly if no value is passed to valOne and valTwo. Because the default gets defined correctly (from dist file):

import { defineComponent as m, openBlock as l, createElementBlock as r, createElementVNode as t, toDisplayString as s, defineAsyncComponent as _, createVNode as u, unref as i, defineCustomElement as p } from "vue";
const d = { class: "component-a" }, C = /* @__PURE__ */ m({
  __name: "ComponentA",
  props: {
    foo: { default: 1 },
    valOne: { default: 2.5 },
    valTwo: { default: 0.5 }
  },

I would almost think that this withDefaults option doesn't enforce the number type.

Thank you again!

[baiwusanyu-c]

I think this is a bug. The compiler does not compile the type information of the props under the product environment, but the Custom Element does not do special processing in this situation in Runtime

cc/@sxzz

[LinusBorg]

@baiwusanyu-c This is a bug, but your PR won't comletely solve it. when defining a prop like this, without a default:

<script setup lang="ts">
    const props = defineProps<{
      foo: number
    }>()
</script>
<template>
<div>{{ foo + bar }}</div>
</template>

We end up with this in production:

const __sfc__ = _defineComponent({
  __name: 'Comp',
  props: {
    foo: {}
  },
  setup(__props) {

That's a behavior of definePropswhen using it with TS props definition style, the reasoning being that we don't need runtime props defitions when we provide types for the consumer.

But when using such a component as a custom element, we get the reported problem, as now the custom element has no way of knowing, at runtime, that it needs to cast this attribute as a number.

This likely needs a solution at the compiler level. Either the stripping of props types needs to be removed completely, or it needs to be deactivated when compiling a component as a custom component (*.ce.vue)

[baiwusanyu-c]

You are right, thank you for your help, let me think about how to do it🧐

[SavkaTaras]

Hey @LinusBorg @baiwusanyu-c ,

Do you guys think it's worth adding a Number() wrapper around any number value? It would enforce the number conversion. Since the user is clearly defining a number, the enforcement could be helpful.

Thanks

[baiwusanyu-c]

Hey @LinusBorg @baiwusanyu-c ,

Do you guys think it's worth adding a Number() wrapper around any number value? It would enforce the number conversion. Since the user is clearly defining a number, the enforcement could be helpful.

Thanks

This case of customElement can be specially handled in the compiler, I made some changes in pr, it is not perfect, I don't have time over the weekend, I will improve it next week

[SavkaTaras]

@baiwusanyu-c no worries at all. I saw the PR changes. I was just thinking maybe that could help.

Thank you again

[funkso2010]

Hello @baiwusanyu-c & @sxzz ,
I hope you are doing well.

Do you guys have any estimates when the new version of vue3 is going to be released?

Thank you!

[SavkaTaras]

Hello Vue team.

Do you guys have any idea when the fix would be available for this issue (released)?

Thank you.

[SavkaTaras]

Hello @LinusBorg , @sxzz , @baiwusanyu-c ,
I hope you are well.

I'm still getting the issue after updating "@vitejs/plugin-vue": "^4.5.2".

Please let me know if you guys can reproduce. I pushed updated package versions into the repo.

Thank you,
Taras

[LinusBorg]

that's because we haven't had a new patch release for Vue since we merged #8989

the changes in the vite plugin are a prerequisite for that.

[sxzz]

[email protected] is released now.