feat(props): provide props to validation #3258

nandi95 · 2021-02-18T21:27:37Z

Added all props to the prop validator as a second argument

nandi95 · 2021-02-18T21:28:45Z

packages/runtime-core/__tests__/componentProps.spec.ts

@@ -275,6 +275,28 @@ describe('component props', () => {
    expect(root.innerHTML).toBe('<div id="b">2</div>')
  })

+  test('validator arguments', async () => {


This file looks like the right place but can't see any tests relating to prop validation, nor elsewhere apart from type tests.

Also can't find if there's a type test for the arguments of the validator?

nandi95 · 2021-02-18T21:29:21Z

packages/runtime-core/src/componentProps.ts

@@ -466,7 +466,7 @@ function validateProps(props: Data, instance: ComponentInternalInstance) {
  for (const key in options) {
    let opt = options[key]
    if (opt == null) continue
-    validateProp(key, rawValues[key], opt, !hasOwn(rawValues, key))
+    validateProp(key, rawValues[key], opt, rawValues, !hasOwn(rawValues, key))


I think this should be cloned deep. Is there an existing utility for that? I could not find one.

Also should the prop value we're originally testing for be filtered out of this rawValues? (just so there's no confusion why it's available twice)

should mark the rawValues as shallowReadonly?

That's perfect. The following still stands:

Also should the prop value we're originally testing for be filtered out of this rawValues? (just so there's no confusion why it's available twice)

nandi95 · 2021-02-20T12:13:00Z

Marked it as ready for review, so I can get some feedback

nandi95 · 2021-02-23T09:26:50Z

@HcySunYang can this be re-reviewed please?

posva

Nice!
Since this is a new feature and it didn't go through an RFC, I think it's worth getting more feedback from the team before merging

nandi95 · 2021-03-02T14:42:50Z

Can this PR have couple more reviews on it?

kuanyui · 2021-03-22T03:36:56Z

Any review progression on this PR? I think this is a necessary feature for validator.
I'm making a customed <Input> component like this, but the current API seems no way to refer a prop from another prop:

type input_type_t = 'number' | 'text' | 'password'
const ALL_INPUT_TYPE: input_type_t[] = ['number', 'text', 'password']
// ...
props: {
    type: {
      default: 'text',
      type: String as PropType<input_type_t>, 
      validator: (x: input_type_t) => ALL_INPUT_TYPE.includes(x)
    },
    modelValue: {   // I want to validate this prop according to the value of `props.type`
      required: true,  
      type: ????????? // Don't know how to refer to the value and TS type information from another prop (`props.type`)
      validator: (x: any) => ????????? // Don't know how to refer to the value and TS type information from another prop (`props.type`)
    },
}

HcySunYang · 2021-03-29T06:06:58Z

@nandi95 this needs to be rebased now

nandi95 · 2021-06-06T10:00:52Z

@posva
Could you perhaps tag some team members to get some movement on this?

IS-Kuan · 2021-07-06T11:15:28Z

Just want to know the progression of review on this PR? Waiting for this feature for months, currently still do this in setup() manually.

nandi95 · 2021-08-06T08:45:42Z

Can we have some movement on this PR?

Added all props to the prop validator as a second argument vuejs#3254

nandi95 · 2022-02-18T08:18:08Z

Happy birthday to this PR 🎉 🎉 🎈
It's already one year old, can't believe how fast time flies. 🥺🥺
😅

SnowingFox · 2022-03-14T13:20:03Z

I want to know why this PR are always be opend since it was born? No malice, just want to know

netlify · 2022-10-26T08:04:08Z

❌ Deploy Preview for vue-sfc-playground failed.

Name	Link
🔨 Latest commit	`a32f7f7`
🔍 Latest deploy log	https://app.netlify.com/sites/vue-sfc-playground/deploys/6358e9bffab9d70008a6554f

netlify · 2022-10-26T08:04:12Z

❌ Deploy Preview for vue-next-template-explorer failed.

Name	Link
🔨 Latest commit	`a32f7f7`
🔍 Latest deploy log	https://app.netlify.com/sites/vue-next-template-explorer/deploys/6358e9bf21070f00096fe8d5

netlify · 2022-10-26T08:04:19Z

❌ Deploy Preview for vuejs-coverage failed.

Name	Link
🔨 Latest commit	`a32f7f7`
🔍 Latest deploy log	https://app.netlify.com/sites/vuejs-coverage/deploys/6358e9bf21070f00096fe8d0

nandi95 · 2023-03-04T08:12:18Z

@yyx990803 @HcySunYang @pikax
Can we get any movement on this?

github-actions · 2023-10-19T13:23:48Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	85.9 kB	32.6 kB	29.5 kB
vue.global.prod.js	132 kB	49.3 kB	44.4 kB

Usages

Name	Size	Gzip	Brotli
createApp	47.9 kB	18.8 kB	17.2 kB
createSSRApp	50.6 kB	19.9 kB	18.2 kB
defineCustomElement	50.3 kB	19.6 kB	17.9 kB
overall	61.2 kB	23.7 kB	21.6 kB

nandi95 commented Feb 18, 2021

View reviewed changes

nandi95 marked this pull request as ready for review February 20, 2021 12:12

nandi95 requested a review from HcySunYang February 20, 2021 16:18

HcySunYang approved these changes Feb 23, 2021

View reviewed changes

posva approved these changes Feb 23, 2021

View reviewed changes

HcySunYang added the 🍰 p2-nice-to-have Priority 2: this is not breaking anything but nice to have it addressed. label Mar 29, 2021

yyx990803 force-pushed the master branch from 24f486f to fb96a85 Compare May 8, 2021 04:46

edison1105 approved these changes Jul 6, 2021

View reviewed changes

yyx990803 force-pushed the master branch from 68e8c2f to f994b97 Compare July 27, 2021 22:42

yyx990803 force-pushed the master branch from a57803f to e9c0694 Compare September 20, 2021 02:04

nandi95 added 2 commits September 28, 2021 14:36

feat(props): provide props to validation

40b3232

Added all props to the prop validator as a second argument vuejs#3254

feat(props): configured prop argument to readonly

a7b5f1c

nandi95 force-pushed the feat/prop-arguments branch from 18eb597 to a7b5f1c Compare September 28, 2021 13:39

pikax approved these changes Oct 10, 2021

View reviewed changes

pikax added the ready to merge The PR is ready to be merged. label Oct 10, 2021

Update componentProps.ts

a32f7f7

vuejs deleted a comment from vue-bot Feb 10, 2023

sxzz approved these changes Mar 7, 2023

View reviewed changes

posva approved these changes Mar 7, 2023

View reviewed changes

Merge branch 'main' into feat/prop-arguments

e35cda6

yyx990803 added the version: minor label Jul 10, 2023

sxzz force-pushed the main branch from 39d4fc1 to 1b56405 Compare August 21, 2023 05:00

Merge branch 'main' into feat/prop-arguments

4018e17

yyx990803 changed the base branch from main to minor December 5, 2023 09:11

jest -> vi

b2d42d6

yyx990803 merged commit 8e27692 into vuejs:minor Dec 5, 2023
2 checks passed

nandi95 deleted the feat/prop-arguments branch December 5, 2023 10:06

Lehoczky mentioned this pull request Jan 4, 2024

Prop cross-validation #3254

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(props): provide props to validation #3258

feat(props): provide props to validation #3258

nandi95 commented Feb 18, 2021

nandi95 Feb 18, 2021

nandi95 Feb 18, 2021

nandi95 Feb 18, 2021

nandi95 Feb 18, 2021

HcySunYang Feb 20, 2021 •

edited

Loading

nandi95 Feb 20, 2021

nandi95 commented Feb 20, 2021

nandi95 commented Feb 23, 2021

posva left a comment

nandi95 commented Mar 2, 2021

kuanyui commented Mar 22, 2021 •

edited

Loading

HcySunYang commented Mar 29, 2021

nandi95 commented Jun 6, 2021

IS-Kuan commented Jul 6, 2021

nandi95 commented Aug 6, 2021

nandi95 commented Feb 18, 2022

SnowingFox commented Mar 14, 2022 •

edited

Loading

netlify bot commented Oct 26, 2022

netlify bot commented Oct 26, 2022

netlify bot commented Oct 26, 2022

nandi95 commented Mar 4, 2023

github-actions bot commented Oct 19, 2023

feat(props): provide props to validation #3258

feat(props): provide props to validation #3258

Conversation

nandi95 commented Feb 18, 2021

nandi95 Feb 18, 2021

Choose a reason for hiding this comment

nandi95 Feb 18, 2021

Choose a reason for hiding this comment

nandi95 Feb 18, 2021

Choose a reason for hiding this comment

nandi95 Feb 18, 2021

Choose a reason for hiding this comment

HcySunYang Feb 20, 2021 • edited Loading

Choose a reason for hiding this comment

nandi95 Feb 20, 2021

Choose a reason for hiding this comment

nandi95 commented Feb 20, 2021

nandi95 commented Feb 23, 2021

posva left a comment

Choose a reason for hiding this comment

nandi95 commented Mar 2, 2021

kuanyui commented Mar 22, 2021 • edited Loading

HcySunYang commented Mar 29, 2021

nandi95 commented Jun 6, 2021

IS-Kuan commented Jul 6, 2021

nandi95 commented Aug 6, 2021

nandi95 commented Feb 18, 2022

SnowingFox commented Mar 14, 2022 • edited Loading

netlify bot commented Oct 26, 2022

❌ Deploy Preview for vue-sfc-playground failed.

netlify bot commented Oct 26, 2022

❌ Deploy Preview for vue-next-template-explorer failed.

netlify bot commented Oct 26, 2022

❌ Deploy Preview for vuejs-coverage failed.

nandi95 commented Mar 4, 2023

github-actions bot commented Oct 19, 2023

Size Report

Bundles

Usages

HcySunYang Feb 20, 2021 •

edited

Loading

kuanyui commented Mar 22, 2021 •

edited

Loading

SnowingFox commented Mar 14, 2022 •

edited

Loading