Merge pull request #205 from WebDevEtc/issue-204-support-propsdata

feat(mount): add support for propsData

Author: lmiller1990

src/mount.ts

@@ -47,6 +47,8 @@ interface MountingOptions<Props, Data = {}> {
     ? Partial<Data>
     : never
   props?: Props
+  /** @deprecated */
+  propsData?: Props
   attrs?: Record<string, unknown>
   slots?: SlotDictionary & {
     default?: Slot
@@ -258,6 +260,7 @@ export function mount(
   // Vue's reactivity system will cause a rerender.
   const props = reactive({
     ...options?.attrs,
+    ...options?.propsData,
     ...options?.props,
     ref: MOUNT_COMPONENT_REF
   })

test-dts/mount.d-test.ts

@@ -20,6 +20,13 @@ expectType<string>(
   }).vm.a
 )
 
+// accept propsData - vm is properly typed
+expectType<string>(
+  mount(AppWithDefine, {
+    propsData: { a: 'Hello', b: 2 }
+  }).vm.a
+)
+
 // no data provided
 expectError(
   mount(AppWithDefine, {

tests/mountingOptions/props.spec.ts

@@ -26,6 +26,27 @@ describe('mountingOptions.props', () => {
     expect(wrapper.text()).toBe('Message is Hello')
   })
 
+  test("passes props with 'propsData'", () => {
+    const wrapper = mount(Component, {
+      propsData: {
+        message: 'Hello'
+      }
+    })
+    expect(wrapper.text()).toBe('Message is Hello')
+  })
+
+  test("uses props from 'props' attribute, when 'propsData' also contains same attribute keys", () => {
+    const wrapper = mount(Component, {
+      propsData: {
+        message: 'Hello from propsData'
+      },
+      props: {
+        message: 'Hello from props'
+      }
+    })
+    expect(wrapper.text()).toBe('Message is Hello from props')
+  })
+
   test('assigns extra properties as attributes on components', () => {
     const wrapper = mount(Component, {
       props: {