Skip to content

fix(routerlink): allow event handlers under strictTemplates (fix #2484) #2548

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.

Sign up for GitHub

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 1 commit into
base: main
Choose a base branch
from
Open

fix(routerlink): allow event handlers under strictTemplates (fix #2484) #2548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions packages/router/src/RouterLink.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import {
// @ts-ignore
ComponentOptionsMixin,
MaybeRef,
AnchorHTMLAttributes,
} from 'vue'
import { isSameRouteLocationParams, isSameRouteRecord } from './location'
import { routerKey, routeLocationKey } from './injectionSymbols'
Expand Down Expand Up @@ -365,12 +366,20 @@ export const RouterLink: _RouterLinkI = RouterLinkImpl as any
*
* @internal
*/
type LinkAnchorAttrs = Omit<AnchorHTMLAttributes, 'href'>

type _BaseRouterLinkProps = AllowedComponentProps &
ComponentCustomProps &
VNodeProps &
RouterLinkProps

type RouterLinkTypedProps<C extends boolean | undefined> = C extends true
? _BaseRouterLinkProps & { custom: true }
: _BaseRouterLinkProps & { custom?: false | undefined } & LinkAnchorAttrs

export interface _RouterLinkI {
new (): {
$props: AllowedComponentProps &
ComponentCustomProps &
VNodeProps &
RouterLinkProps
new <C extends boolean | undefined = boolean | undefined>(): {
$props: RouterLinkTypedProps<C>

$slots: {
default?: ({
Expand Down
11 changes: 11 additions & 0 deletions packages/router/test-dts/components.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ describe('Components', () => {
expectTypeOf<JSX.Element>(<RouterLink class="link" to="/foo" />)
expectTypeOf<JSX.Element>(<RouterLink to={{ path: '/foo' }} />)
expectTypeOf<JSX.Element>(<RouterLink to={{ path: '/foo' }} custom />)
// event handlers and anchor attrs are allowed when not custom
expectTypeOf<JSX.Element>(
<RouterLink to="/" onFocus={() => {}} onClick={() => {}} />
)
expectTypeOf<JSX.Element>(
<RouterLink to="/" target="_blank" rel="noopener" />
)
// @ts-expect-error: href is intentionally omitted
expectError(<RouterLink to="/" href="/bar" />)
// @ts-expect-error: onFocus should not be allowed with custom
expectError(<RouterLink to="/" custom onFocus={() => {}} />)

// RouterView
expectTypeOf<JSX.Element>(<RouterView class="view" />)
Expand Down