Skip to content
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

fix(types): allow scoped slots to return a single VNode #9563

Merged
merged 3 commits into from Feb 28, 2019

Conversation

KaelWD
Copy link
Contributor

@KaelWD KaelWD commented Feb 24, 2019

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information:

Scoped slots are normalised to VNode[], but they should still be able to return a bare string or VNode when used in a render function.
https://codepen.io/anon/pen/BMXvme?editors=1010

@yyx990803 yyx990803 requested a review from ktsn February 25, 2019 15:41
types/vnode.d.ts Outdated
@@ -1,7 +1,8 @@
import { Vue } from "./vue";

export type ScopedSlot = (props: any) => VNode | VNode[] | string | undefined;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the return type should have similar type with VNodeChildren as it is normalized as same as vnode children.

function normalizeScopedSlot(normalSlots, key, fn) {
const normalized = scope => {
let res = fn(scope || {})
res = res && typeof res === 'object' && !Array.isArray(res)
? [res] // single vnode
: normalizeChildren(res)
return res && res.length === 0
? undefined
: res
}

Maybe it will be:

type ScopedSlot = (props: any) => ScopedSlotReturn;
type ScopedSlotReturn = VNode | string | boolean | null | undefined | ScopedSlotReturnArray;
interface ScopedSlotReturnArray extends Array<ScopedSlotReturn> {}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KaelWD are you planning to update the PR according to the suggestion?

@yyx990803 yyx990803 merged commit 241eea1 into vuejs:dev Feb 28, 2019
@yyx990803 yyx990803 added this to Done in Maintenance via automation Feb 28, 2019
kiku-jw pushed a commit to kiku-jw/vue that referenced this pull request Jun 18, 2019
Lostlover pushed a commit to Lostlover/vue that referenced this pull request Dec 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Maintenance
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants