Skip to content

fix(types): broaden VNodeChildren, fix #8498 #9154

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
Dec 10, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions types/test/options-test.ts
Original file line number Diff line number Diff line change
@@ -281,6 +281,12 @@ Vue.component('provide-function', {
})
})

Vue.component('component-with-slot', {
render (h): VNode {
return h('div', this.$slots.default)
}
})

Vue.component('component-with-scoped-slot', {
render (h) {
interface ScopedSlotProps {
@@ -301,6 +307,12 @@ Vue.component('component-with-scoped-slot', {
h('child', {
// Passing down all slots from parent
scopedSlots: this.$scopedSlots
}),
h('child', {
// Passing down single slot from parent
scopedSlots: {
default: this.$scopedSlots.default
}
})
])
},
@@ -320,16 +332,22 @@ Vue.component('narrow-array-of-vnode-type', {
render (h): VNode {
const slot = this.$scopedSlots.default!({})
if (typeof slot === 'string') {
// <template slot-scope="data">bare string</template>
return h('span', slot)
} else if (Array.isArray(slot)) {
// template with multiple children
const first = slot[0]
if (!Array.isArray(first) && typeof first !== 'string') {
if (!Array.isArray(first) && typeof first !== 'string' && first) {
return first
} else {
return h()
}
} else {
} else if (slot) {
// <div slot-scope="data">bare VNode</div>
return slot
} else {
// empty template, slot === undefined
return h()
}
}
})
13 changes: 9 additions & 4 deletions types/vnode.d.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
import { Vue } from "./vue";

export type ScopedSlot = (props: any) => VNodeChildrenArrayContents | VNode | string;
// Scoped slots can technically return anything if used from
// a render function, but this is "good enough" for templates
export type ScopedSlot = (props: any) => ScopedSlotChildren;
export type ScopedSlotChildren = ScopedSlotArrayContents | VNode | string | undefined;
export interface ScopedSlotArrayContents extends Array<ScopedSlotChildren> {}

export type VNodeChildren = VNodeChildrenArrayContents | [ScopedSlot] | string;
export interface VNodeChildrenArrayContents extends Array<VNode | string | VNodeChildrenArrayContents> {}
// Relaxed type compatible with $createElement
export type VNodeChildren = VNodeChildrenArrayContents | [ScopedSlot] | string | boolean | null | undefined;
export interface VNodeChildrenArrayContents extends Array<VNodeChildren | VNode> {}

export interface VNode {
tag?: string;
@@ -27,7 +32,7 @@ export interface VNodeComponentOptions {
Ctor: typeof Vue;
propsData?: object;
listeners?: object;
children?: VNodeChildren;
children?: VNode[];
tag?: string;
}