Backstage
    Preparing search index...

    Interface LinkProps

    interface LinkProps {
        "aria-describedby"?: string;
        "aria-details"?: string;
        "aria-label"?: string;
        "aria-labelledby"?: string;
        autoFocus?: boolean;
        children?: ReactNode;
        className?: string;
        color?:
            | TextColors
            | TextColorStatus
            | Partial<Record<Breakpoint, (TextColors | TextColorStatus)>>;
        dir?: string;
        download?: string | boolean;
        hidden?: boolean;
        href?: string;
        hrefLang?: string;
        id?: string;
        inert?: boolean;
        isDisabled?: boolean;
        lang?: string;
        noTrack?: boolean;
        onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>;
        onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>;
        onAuxClick?: MouseEventHandler<HTMLAnchorElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>;
        onBlur?: (e: FocusEvent<Element>) => void;
        onClick?: (e: MouseEvent<FocusableElement>) => void;
        onClickCapture?: MouseEventHandler<HTMLAnchorElement>;
        onContextMenu?: MouseEventHandler<HTMLAnchorElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>;
        onDoubleClick?: MouseEventHandler<HTMLAnchorElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>;
        onFocus?: (e: FocusEvent<Element>) => void;
        onFocusChange?: (isFocused: boolean) => void;
        onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>;
        onHoverChange?: (isHovering: boolean) => void;
        onHoverEnd?: (e: HoverEvent) => void;
        onHoverStart?: (e: HoverEvent) => void;
        onKeyDown?: (e: KeyboardEvent) => void;
        onKeyUp?: (e: KeyboardEvent) => void;
        onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>;
        onMouseDown?: MouseEventHandler<HTMLAnchorElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>;
        onMouseEnter?: MouseEventHandler<HTMLAnchorElement>;
        onMouseLeave?: MouseEventHandler<HTMLAnchorElement>;
        onMouseMove?: MouseEventHandler<HTMLAnchorElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>;
        onMouseOut?: MouseEventHandler<HTMLAnchorElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>;
        onMouseOver?: MouseEventHandler<HTMLAnchorElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>;
        onMouseUp?: MouseEventHandler<HTMLAnchorElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>;
        onPointerCancel?: PointerEventHandler<HTMLAnchorElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>;
        onPointerDown?: PointerEventHandler<HTMLAnchorElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>;
        onPointerEnter?: PointerEventHandler<HTMLAnchorElement>;
        onPointerLeave?: PointerEventHandler<HTMLAnchorElement>;
        onPointerMove?: PointerEventHandler<HTMLAnchorElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>;
        onPointerOut?: PointerEventHandler<HTMLAnchorElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>;
        onPointerOver?: PointerEventHandler<HTMLAnchorElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>;
        onPointerUp?: PointerEventHandler<HTMLAnchorElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>;
        onPress?: (e: PressEvent) => void;
        onPressChange?: (isPressed: boolean) => void;
        onPressEnd?: (e: PressEvent) => void;
        onPressStart?: (e: PressEvent) => void;
        onPressUp?: (e: PressEvent) => void;
        onScroll?: UIEventHandler<HTMLAnchorElement>;
        onScrollCapture?: UIEventHandler<HTMLAnchorElement>;
        onTouchCancel?: TouchEventHandler<HTMLAnchorElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>;
        onTouchEnd?: TouchEventHandler<HTMLAnchorElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>;
        onTouchMove?: TouchEventHandler<HTMLAnchorElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>;
        onTouchStart?: TouchEventHandler<HTMLAnchorElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLAnchorElement>;
        onTransitionCancelCapture?: TransitionEventHandler<HTMLAnchorElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>;
        onTransitionRun?: TransitionEventHandler<HTMLAnchorElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLAnchorElement>;
        onTransitionStart?: TransitionEventHandler<HTMLAnchorElement>;
        onTransitionStartCapture?: TransitionEventHandler<HTMLAnchorElement>;
        onWheel?: WheelEventHandler<HTMLAnchorElement>;
        onWheelCapture?: WheelEventHandler<HTMLAnchorElement>;
        ping?: string;
        referrerPolicy?: HTMLAttributeReferrerPolicy;
        rel?: string;
        render?: (
            props:
                | DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>
                | DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement>,
            renderProps: LinkRenderProps,
        ) => ReactElement;
        routerOptions?: NavigateOptions;
        slot?: string | null;
        standalone?: boolean;
        style?: StyleOrFunction<LinkRenderProps>;
        target?: HTMLAttributeAnchorTarget;
        title?: string;
        translate?: "yes" | "no";
        truncate?: boolean;
        variant?: TextVariants | Partial<Record<Breakpoint, TextVariants>>;
        weight?: TextWeights | Partial<Record<Breakpoint, TextWeights>>;
    }

    Hierarchy (View Summary)

    • Omit<AriaLinkProps, "children" | "className">
    • LinkOwnProps
      • LinkProps
    Index

    Properties

    aria-describedby? aria-details? aria-label? aria-labelledby? autoFocus? children? className? color? dir? download? hidden? href? hrefLang? id? inert? isDisabled? lang? noTrack? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBlur? onClick? onClickCapture? onContextMenu? onContextMenuCapture? onDoubleClick? onDoubleClickCapture? onFocus? onFocusChange? onGotPointerCapture? onGotPointerCaptureCapture? onHoverChange? onHoverEnd? onHoverStart? onKeyDown? onKeyUp? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onPress? onPressChange? onPressEnd? onPressStart? onPressUp? onScroll? onScrollCapture? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onWheel? onWheelCapture? ping? referrerPolicy? rel? render? routerOptions? slot? standalone? style? target? title? translate? truncate? variant? weight?

    Properties

    "aria-describedby"?: string

    Identifies the element (or elements) that describes the object.

    "aria-details"?: string

    Identifies the element (or elements) that provide a detailed, extended description for the object.

    "aria-label"?: string

    Defines a string value that labels the current element.

    "aria-labelledby"?: string

    Identifies the element (or elements) that labels the current element.

    autoFocus?: boolean

    Whether the element should receive focus on render.

    children?: ReactNode
    className?: string
    color?:
        | TextColors
        | TextColorStatus
        | Partial<Record<Breakpoint, (TextColors | TextColorStatus)>>
    dir?: string
    download?: string | boolean

    Causes the browser to download the linked URL. A string may be provided to suggest a file name. See MDN.

    hidden?: boolean
    href?: string

    A URL to link to. See MDN.

    hrefLang?: string

    Hints at the human language of the linked URL. SeeMDN.

    id?: string

    The element's unique identifier. See MDN.

    inert?: boolean
    isDisabled?: boolean

    Whether the link is disabled.

    lang?: string
    noTrack?: boolean
    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>
    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>
    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>
    onAuxClick?: MouseEventHandler<HTMLAnchorElement>
    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>
    onBlur?: (e: FocusEvent<Element>) => void

    Handler that is called when the element loses focus.

    onClick?: (e: MouseEvent<FocusableElement>) => void

    Not recommended – use onPress instead. onClick is an alias for onPress provided for compatibility with other libraries. onPress provides additional event details for non-mouse interactions.

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>
    onContextMenu?: MouseEventHandler<HTMLAnchorElement>
    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>
    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>
    onFocus?: (e: FocusEvent<Element>) => void

    Handler that is called when the element receives focus.

    onFocusChange?: (isFocused: boolean) => void

    Handler that is called when the element's focus status changes.

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>
    onHoverChange?: (isHovering: boolean) => void

    Handler that is called when the hover state changes.

    onHoverEnd?: (e: HoverEvent) => void

    Handler that is called when a hover interaction ends.

    onHoverStart?: (e: HoverEvent) => void

    Handler that is called when a hover interaction starts.

    onKeyDown?: (e: KeyboardEvent) => void

    Handler that is called when a key is pressed.

    onKeyUp?: (e: KeyboardEvent) => void

    Handler that is called when a key is released.

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>
    onMouseDown?: MouseEventHandler<HTMLAnchorElement>
    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>
    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>
    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>
    onMouseMove?: MouseEventHandler<HTMLAnchorElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>
    onMouseOut?: MouseEventHandler<HTMLAnchorElement>
    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>
    onMouseOver?: MouseEventHandler<HTMLAnchorElement>
    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>
    onMouseUp?: MouseEventHandler<HTMLAnchorElement>
    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>
    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>
    onPointerDown?: PointerEventHandler<HTMLAnchorElement>
    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>
    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>
    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>
    onPointerMove?: PointerEventHandler<HTMLAnchorElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>
    onPointerOut?: PointerEventHandler<HTMLAnchorElement>
    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>
    onPointerOver?: PointerEventHandler<HTMLAnchorElement>
    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>
    onPointerUp?: PointerEventHandler<HTMLAnchorElement>
    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>
    onPress?: (e: PressEvent) => void

    Handler that is called when the press is released over the target.

    onPressChange?: (isPressed: boolean) => void

    Handler that is called when the press state changes.

    onPressEnd?: (e: PressEvent) => void

    Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.

    onPressStart?: (e: PressEvent) => void

    Handler that is called when a press interaction starts.

    onPressUp?: (e: PressEvent) => void

    Handler that is called when a press is released over the target, regardless of whether it started on the target or not.

    onScroll?: UIEventHandler<HTMLAnchorElement>
    onScrollCapture?: UIEventHandler<HTMLAnchorElement>
    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>
    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>
    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>
    onTouchMove?: TouchEventHandler<HTMLAnchorElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>
    onTouchStart?: TouchEventHandler<HTMLAnchorElement>
    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>
    onTransitionCancel?: TransitionEventHandler<HTMLAnchorElement>
    onTransitionCancelCapture?: TransitionEventHandler<HTMLAnchorElement>
    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>
    onTransitionRun?: TransitionEventHandler<HTMLAnchorElement>
    onTransitionRunCapture?: TransitionEventHandler<HTMLAnchorElement>
    onTransitionStart?: TransitionEventHandler<HTMLAnchorElement>
    onTransitionStartCapture?: TransitionEventHandler<HTMLAnchorElement>
    onWheel?: WheelEventHandler<HTMLAnchorElement>
    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>
    ping?: string

    A space-separated list of URLs to ping when the link is followed. See MDN.

    referrerPolicy?: HTMLAttributeReferrerPolicy

    How much of the referrer to send when following the link. See MDN.

    rel?: string

    The relationship between the linked resource and the current page. See MDN.

    render?: (
        props:
            | DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>
            | DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement>,
        renderProps: LinkRenderProps,
    ) => ReactElement

    Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

    Note: You can check if 'href' in props in order to tell whether to render an <a> element.

    Requirements:

    • You must render the expected element type (e.g. if <a> is expected, you cannot render a <button>).
    • Only a single root DOM element can be rendered (no fragments).
    • You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
    routerOptions?: NavigateOptions

    Options for the configured client side router.

    slot?: string | null

    A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

    standalone?: boolean
    style?: StyleOrFunction<LinkRenderProps>

    The inline style for the element. A function may be provided to compute the style based on component state.

    target?: HTMLAttributeAnchorTarget

    The target window for the link. See MDN.

    title?: string
    translate?: "yes" | "no"
    truncate?: boolean
    variant?: TextVariants | Partial<Record<Breakpoint, TextVariants>>
    weight?: TextWeights | Partial<Record<Breakpoint, TextWeights>>

    Settings

    Member Visibility

    On This Page

    Properties
    aria-describedbyaria-detailsaria-labelaria-labelledbyautoFocuschildrenclassNamecolordirdownloadhiddenhrefhrefLangidinertisDisabledlangnoTrackonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBluronClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonFocusonFocusChangeonGotPointerCaptureonGotPointerCaptureCaptureonHoverChangeonHoverEndonHoverStartonKeyDownonKeyUponLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonPressonPressChangeonPressEndonPressStartonPressUponScrollonScrollCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturepingreferrerPolicyrelrenderrouterOptionsslotstandalonestyletargettitletranslatetruncatevariantweight