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: custom directive doesn't work when custom=true #2377

Merged
merged 2 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
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
75 changes: 37 additions & 38 deletions packages/router/__tests__/RouterLink.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,8 @@ async function factory(
currentLocation: RouteLocationNormalized,
propsData: any,
resolvedLocation: RouteLocationResolved,
slotTemplate: string = ''
slotTemplate: string = '',
component: any = RouterLink
) {
const route = createMockedRoute(currentLocation)
const router = {
Expand All @@ -373,7 +374,7 @@ async function factory(
}
router.resolve.mockReturnValueOnce(resolvedLocation)

const wrapper = mount(RouterLink as any, {
const wrapper = mount(component, {
propsData,
global: {
provide: {
Expand Down Expand Up @@ -899,6 +900,32 @@ describe('RouterLink', () => {
expect(wrapper.html()).not.toContain('</a>')
})

// #2375
it('works with custom directive when custom=true', async () => {
const Directive = (el: HTMLElement) => el.setAttribute('data-test', 'x')
const AppLink = defineComponent({
template: `
<router-link custom v-directive>
<a></a>
</router-link>
`,
components: { RouterLink },
directives: { Directive },
name: 'AppLink',
})

const { wrapper } = await factory(
locations.basic.normalized,
{ to: locations.basic.string },
locations.basic.normalized,
undefined,
AppLink
)

expect(wrapper.element.tagName).toBe('A')
expect(wrapper.attributes('data-test')).toBe('x')
})

describe('Extending RouterLink', () => {
const AppLink = defineComponent({
template: `
Expand Down Expand Up @@ -932,59 +959,31 @@ describe('RouterLink', () => {
},
})

async function factoryCustom(
currentLocation: RouteLocationNormalized,
propsData: any,
resolvedLocation: RouteLocationResolved,
slotTemplate: string = ''
) {
const route = createMockedRoute(currentLocation)
const router = {
history: createMemoryHistory(),
createHref(to: RouteLocationNormalized): string {
return this.history.base + to.fullPath
},
options: {} as Partial<RouterOptions>,
resolve: vi.fn(),
push: vi.fn().mockResolvedValue(resolvedLocation),
}
router.resolve.mockReturnValueOnce(resolvedLocation)

const wrapper = await mount(AppLink as any, {
propsData,
global: {
provide: {
[routerKey as any]: router,
...route.provides,
},
},
slots: { default: slotTemplate },
})

return { router, wrapper, route }
}

it('can extend RouterLink with inactive class', async () => {
const { wrapper } = await factoryCustom(
const { wrapper } = await factory(
locations.basic.normalized,
{
to: locations.basic.string,
inactiveClass: 'inactive',
activeClass: 'active',
},
locations.foo.normalized
locations.foo.normalized,
undefined,
AppLink
)

expect(wrapper.find('a')!.classes()).toEqual(['inactive'])
})

it('can extend RouterLink with external link', async () => {
const { wrapper } = await factoryCustom(
const { wrapper } = await factory(
locations.basic.normalized,
{
to: 'https://esm.dev',
},
locations.foo.normalized
locations.foo.normalized,
undefined,
AppLink
)

expect(wrapper.find('a')!.classes()).toHaveLength(0)
Expand Down
6 changes: 5 additions & 1 deletion packages/router/src/RouterLink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,10 @@ export function useLink<Name extends keyof RouteMap = keyof RouteMap>(
}
}

function preferSingleVNode(vnodes: VNode[]) {
return vnodes.length === 1 ? vnodes[0] : vnodes
}

export const RouterLinkImpl = /*#__PURE__*/ defineComponent({
name: 'RouterLink',
compatConfig: { MODE: 3 },
Expand Down Expand Up @@ -307,7 +311,7 @@ export const RouterLinkImpl = /*#__PURE__*/ defineComponent({
}))

return () => {
const children = slots.default && slots.default(link)
const children = slots.default && preferSingleVNode(slots.default(link))
return props.custom
? children
: h(
Expand Down