Skip to content

feat(vapor): forwarded slots #13408

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

Open
wants to merge 23 commits into
base: minor
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
dde7076
feat(compiler-vapor): add support for forwarded slots
edison1105 May 29, 2025
a952b03
test: add tests
edison1105 May 29, 2025
c23d635
chore: update
edison1105 May 30, 2025
dcf927f
fix(vdomInterop): handle forwarded vapor slots during render VDOM slot
edison1105 May 30, 2025
7cfec7f
wip: vdom slot interop
edison1105 Jun 11, 2025
f4f0388
wip: refactor tests
edison1105 Jun 12, 2025
4435a2e
chore: use fragment's anchor as insertion point
edison1105 Jun 13, 2025
748686a
chore: Merge branch 'vapor' into edison/feat/fowardedSlots
edison1105 Jun 20, 2025
d85ff5e
Merge branch 'minor' into edison/feat/fowardedSlots
edison1105 Jul 16, 2025
2ba4dc0
fix(runtime-vapor): render slot fallback if slot content is not a val…
edison1105 Jul 21, 2025
f5a8fc5
Merge branch 'minor' into edison/feat/fowardedSlots
edison1105 Jul 21, 2025
e92244e
chore: tweaks
edison1105 Jul 22, 2025
e28b96b
chore: tweaks
edison1105 Jul 22, 2025
a65da3a
wip: render fallback nodes for vfor
edison1105 Jul 23, 2025
e3ad645
chore: Merge branch 'edison/fix/vaporSlotFallback' into edison/feat/f…
edison1105 Jul 23, 2025
1ab9cc1
chore: tweaks
edison1105 Jul 25, 2025
e370ed8
Merge branch 'edison/fix/vaporSlotFallback' into edison/feat/fowarded…
edison1105 Jul 25, 2025
30af803
chore: tweaks
edison1105 Jul 25, 2025
e0f544a
chore: Merge branch 'edison/fix/vaporSlotFallback' into edison/feat/f…
edison1105 Jul 25, 2025
b8ceb89
chore: tweaks
edison1105 Jul 25, 2025
5c6e533
fix(runtime-vapor): improve fallback handling for nested fragments
edison1105 Jul 25, 2025
92399d9
chore: Merge branch 'edison/fix/vaporSlotFallback' into edison/feat/f…
edison1105 Jul 25, 2025
5b4673f
chore: tweaks
edison1105 Jul 25, 2025
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
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,97 @@ export function render(_ctx) {
}"
`;

exports[`compiler: transform slot > forwarded slots > <slot w/ nested component> 1`] = `
"import { forwardedSlotCreator as _forwardedSlotCreator, resolveComponent as _resolveComponent, createComponentWithFallback as _createComponentWithFallback } from 'vue';

export function render(_ctx) {
const _createForwardedSlot = _forwardedSlotCreator()
const _component_Comp = _resolveComponent("Comp")
const n2 = _createComponentWithFallback(_component_Comp, null, {
"default": () => {
const n1 = _createComponentWithFallback(_component_Comp, null, {
"default": () => {
const n0 = _createForwardedSlot("default", null)
return n0
}
})
return n1
}
}, true)
return n2
}"
`;

exports[`compiler: transform slot > forwarded slots > <slot> tag only 1`] = `
"import { forwardedSlotCreator as _forwardedSlotCreator, resolveComponent as _resolveComponent, createComponentWithFallback as _createComponentWithFallback } from 'vue';

export function render(_ctx) {
const _createForwardedSlot = _forwardedSlotCreator()
const _component_Comp = _resolveComponent("Comp")
const n1 = _createComponentWithFallback(_component_Comp, null, {
"default": () => {
const n0 = _createForwardedSlot("default", null)
return n0
}
}, true)
return n1
}"
`;

exports[`compiler: transform slot > forwarded slots > <slot> tag w/ template 1`] = `
"import { forwardedSlotCreator as _forwardedSlotCreator, resolveComponent as _resolveComponent, createComponentWithFallback as _createComponentWithFallback } from 'vue';

export function render(_ctx) {
const _createForwardedSlot = _forwardedSlotCreator()
const _component_Comp = _resolveComponent("Comp")
const n2 = _createComponentWithFallback(_component_Comp, null, {
"default": () => {
const n0 = _createForwardedSlot("default", null)
return n0
}
}, true)
return n2
}"
`;

exports[`compiler: transform slot > forwarded slots > <slot> tag w/ v-for 1`] = `
"import { forwardedSlotCreator as _forwardedSlotCreator, resolveComponent as _resolveComponent, createFor as _createFor, createComponentWithFallback as _createComponentWithFallback } from 'vue';

export function render(_ctx) {
const _createForwardedSlot = _forwardedSlotCreator()
const _component_Comp = _resolveComponent("Comp")
const n3 = _createComponentWithFallback(_component_Comp, null, {
"default": () => {
const n0 = _createFor(() => (_ctx.b), (_for_item0) => {
const n2 = _createForwardedSlot("default", null)
return n2
})
return n0
}
}, true)
return n3
}"
`;

exports[`compiler: transform slot > forwarded slots > <slot> tag w/ v-if 1`] = `
"import { forwardedSlotCreator as _forwardedSlotCreator, resolveComponent as _resolveComponent, createIf as _createIf, createComponentWithFallback as _createComponentWithFallback } from 'vue';

export function render(_ctx) {
const _createForwardedSlot = _forwardedSlotCreator()
const _component_Comp = _resolveComponent("Comp")
const n3 = _createComponentWithFallback(_component_Comp, null, {
"default": () => {
const n0 = _createIf(() => (_ctx.ok), () => {
const n2 = _createForwardedSlot("default", null)
return n2
})
return n0
}
}, true)
return n3
}"
`;

exports[`compiler: transform slot > implicit default slot 1`] = `
"import { resolveComponent as _resolveComponent, createComponentWithFallback as _createComponentWithFallback, template as _template } from 'vue';
const t0 = _template("<div></div>")
Expand Down
29 changes: 29 additions & 0 deletions packages/compiler-vapor/__tests__/transforms/vSlot.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,35 @@ describe('compiler: transform slot', () => {
})
})

describe('forwarded slots', () => {
test('<slot> tag only', () => {
const { code } = compileWithSlots(`<Comp><slot/></Comp>`)
expect(code).toMatchSnapshot()
})

test('<slot> tag w/ v-if', () => {
const { code } = compileWithSlots(`<Comp><slot v-if="ok"/></Comp>`)
expect(code).toMatchSnapshot()
})

test('<slot> tag w/ v-for', () => {
const { code } = compileWithSlots(`<Comp><slot v-for="a in b"/></Comp>`)
expect(code).toMatchSnapshot()
})

test('<slot> tag w/ template', () => {
const { code } = compileWithSlots(
`<Comp><template #default><slot/></template></Comp>`,
)
expect(code).toMatchSnapshot()
})

test('<slot w/ nested component>', () => {
const { code } = compileWithSlots(`<Comp><Comp><slot/></Comp></Comp>`)
expect(code).toMatchSnapshot()
})
})

describe('errors', () => {
test('error on extraneous children w/ named default slot', () => {
const onError = vi.fn()
Expand Down
7 changes: 7 additions & 0 deletions packages/compiler-vapor/src/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
genCall,
} from './generators/utils'
import { setTemplateRefIdent } from './generators/templateRef'
import { createForwardedSlotIdent } from './generators/slotOutlet'

export type CodegenOptions = Omit<BaseCodegenOptions, 'optimizeImports'>

Expand Down Expand Up @@ -129,6 +130,12 @@ export function generate(
`const ${setTemplateRefIdent} = ${context.helper('createTemplateRefSetter')}()`,
)
}
if (ir.hasForwardedSlot) {
push(
NEWLINE,
`const ${createForwardedSlotIdent} = ${context.helper('forwardedSlotCreator')}()`,
)
}
push(...genBlockContent(ir.block, context, true))
push(INDENT_END, NEWLINE)

Expand Down
6 changes: 4 additions & 2 deletions packages/compiler-vapor/src/generators/slotOutlet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ import { genExpression } from './expression'
import { type CodeFragment, NEWLINE, buildCodeFragment, genCall } from './utils'
import { genRawProps } from './component'

export const createForwardedSlotIdent = `_createForwardedSlot`

export function genSlotOutlet(
oper: SlotOutletIRNode,
context: CodegenContext,
): CodeFragment[] {
const { helper } = context
const { id, name, fallback } = oper
const { id, name, fallback, forwarded } = oper
const [frag, push] = buildCodeFragment()

const nameExpr = name.isStatic
Expand All @@ -26,7 +28,7 @@ export function genSlotOutlet(
NEWLINE,
`const n${id} = `,
...genCall(
helper('createSlot'),
forwarded ? createForwardedSlotIdent : helper('createSlot'),
nameExpr,
genRawProps(oper.props, context) || 'null',
fallbackArg,
Expand Down
2 changes: 2 additions & 0 deletions packages/compiler-vapor/src/ir/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ export interface RootIRNode {
directive: Set<string>
block: BlockIRNode
hasTemplateRef: boolean
hasForwardedSlot: boolean
}

export interface IfIRNode extends BaseIRNode {
Expand Down Expand Up @@ -208,6 +209,7 @@ export interface SlotOutletIRNode extends BaseIRNode {
name: SimpleExpressionNode
props: IRProps[]
fallback?: BlockIRNode
forwarded?: boolean
parent?: number
anchor?: number
}
Expand Down
2 changes: 2 additions & 0 deletions packages/compiler-vapor/src/transform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ export class TransformContext<T extends AllNode = AllNode> {

inVOnce: boolean = false
inVFor: number = 0
inSlot: boolean = false

comment: CommentNode[] = []
component: Set<string> = this.ir.component
Expand Down Expand Up @@ -219,6 +220,7 @@ export function transform(
directive: new Set(),
block: newBlock(node),
hasTemplateRef: false,
hasForwardedSlot: false,
}

const context = new TransformContext(ir, node, options)
Expand Down
2 changes: 2 additions & 0 deletions packages/compiler-vapor/src/transforms/transformSlotOutlet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,15 @@ export const transformSlotOutlet: NodeTransform = (node, context) => {
}

return () => {
if (context.inSlot) context.ir.hasForwardedSlot = true
exitBlock && exitBlock()
context.dynamic.operation = {
type: IRNodeTypes.SLOT_OUTLET_NODE,
id,
name: slotName,
props: irProps,
fallback,
forwarded: context.inSlot,
}
}
}
Expand Down
9 changes: 8 additions & 1 deletion packages/compiler-vapor/src/transforms/vSlot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,14 @@ function createSlotBlock(
const block: SlotBlockIRNode = newBlock(slotNode)
block.props = dir && dir.exp
const exitBlock = context.enterBlock(block)
return [block, exitBlock]
context.inSlot = true
return [
block,
() => {
context.inSlot = false
exitBlock()
},
]
}

function isNonWhitespaceContent(node: TemplateChildNode): boolean {
Expand Down
21 changes: 21 additions & 0 deletions packages/runtime-core/src/helpers/renderSlot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ export function renderSlot(
}
openBlock()
const validSlotContent = slot && ensureValidVNode(slot(props))

// handle forwarded vapor slot fallback
ensureVaporSlotFallback(validSlotContent, fallback)

const slotKey =
props.key ||
// slot content array of a dynamic conditional slot may have a branch
Expand Down Expand Up @@ -124,3 +128,20 @@ export function ensureValidVNode(
? vnodes
: null
}

export function ensureVaporSlotFallback(
vnodes: VNodeArrayChildren | null | undefined,
fallback?: () => VNodeArrayChildren,
): void {
let vaporSlot: any
if (
vnodes &&
vnodes.length === 1 &&
isVNode(vnodes[0]) &&
(vaporSlot = vnodes[0].vs)
) {
if (!vaporSlot.fallback && fallback) {
vaporSlot.fallback = fallback
}
}
}
4 changes: 4 additions & 0 deletions packages/runtime-core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,10 @@ export { startMeasure, endMeasure } from './profiling'
* @internal
*/
export { initFeatureFlags } from './featureFlags'
/**
* @internal
*/
export { ensureVaporSlotFallback } from './helpers/renderSlot'
/**
* @internal
*/
Expand Down
Loading