UNPKG

@navikt/ds-react

Version:

React components from the Norwegian Labour and Welfare Administration.

59 lines (58 loc) 1.85 kB
import React from "react"; import type { AkselStatusColorRole } from "@navikt/ds-tokens/types"; import { AkselColor } from "../types"; import type { OverridableComponent } from "../utils-external"; export interface LinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> { /** * Inverts when the underline appears. If this is false, * the underline only appears on hover. * * **NB: Underline can only be removed in menus etc. where it's obvious that it's a link.** * @default true */ underline?: boolean; /** * Renders link with `display: inline` for better wrapping in text. * @default false */ inlineText?: boolean; /** * @deprecated Deprecated in v8. Use `data-color` prop instead. */ variant?: "action" | "neutral" | "subtle"; /** * Link text */ children: React.ReactNode; /** * Overrides inherited color. * * We recommend only using `accent` and `neutral`. We have disallowed status-colors. * @see 🏷️ {@link AkselColor} * @see [📝 Documentation](https://aksel.nav.no/grunnleggende/styling/farger-tokens) */ "data-color"?: Exclude<AkselColor, AkselStatusColorRole>; } /** * A component that displays a hyperlink. * * @see [📝 Documentation](https://aksel.nav.no/komponenter/core/link) * @see 🏷️ {@link LinkProps} * @see [🤖 OverridableComponent](https://aksel.nav.no/grunnleggende/kode/overridablecomponent) support * * @example * ```jsx * <Link href="#">lenke til ny side</Link> * <Link as={ReactRouter.Link} to="#">lenke til ny side</Link> * ``` * @example * ```jsx * <BodyLong> * ... * <Link href="#" inlineText>lenke til ny side</Link> * ... * </BodyLong> * ``` */ export declare const Link: OverridableComponent<LinkProps, HTMLAnchorElement>; export default Link;