@veracity/vui/dist/link/link.types.d.ts

Veracity UI is a React component library crafted for use within Veracity applications and pages. Based on Styled Components and @xstyled.

import { ThemingProps } from "../theme/types.js";
import { TypographyProps } from "../system/typography.js";
import { SystemProps } from "../system/system.js";
import { IconProp } from "../icon/icon.types.js";
import { JSX } from "react";

//#region src/link/link.types.d.ts
type LinkProps = SystemProps & ThemingProps<'Link'> & {
  /** Deprecated. Please use variant instead. @deprecated  */colorScheme?: 'blue' | 'white'; /** Alias for textDecoration prop. @deprecated */
  decoration?: TypographyProps['textDecoration']; /** Alias for hoverTextDecoration prop. @deprecated */
  hoverDecoration?: TypographyProps['textDecoration']; /** Href attribute value for the a tag. */
  href?: string; /** Icon displayed on the leading (left) side of the link content. */
  startIcon?: IconProp | JSX.Element; /** Icon displayed on the trailing (right) side of the link content. */
  endIcon?: IconProp | JSX.Element; /** Deprecated alias for `startIcon`. @deprecated */
  iconLeft?: IconProp | JSX.Element; /** Deprecated alias for `endIcon`. @deprecated */
  iconRight?: IconProp | JSX.Element; /** Opens the link in new tab with appropriate attributes. */
  isExternal?: boolean; /** Displays permanent underline. Should be used for inline links within text. */
  isUnderlined?: boolean; /** Socket displaying text within the Link. */
  text?: number | string | JSX.Element; /** Alias for fontWeight prop. @deprecated */
  weight?: TypographyProps['fontWeight'];
};
//#endregion
export { LinkProps };

//# sourceMappingURL=link.types.d.ts.map