carbon-react
Version:
A library of reusable React components for easily building user interfaces.
34 lines (33 loc) • 1.75 kB
TypeScript
/** @deprecated The value 'default' for the variant prop is deprecated and will soon be removed. Please use value 'typical' instead. */
type DeprecatedDefaultVariant = "default";
/** @deprecated The value 'neutral' for the variant prop is deprecated and will soon be removed. Please use value 'subtle' instead. */
type DeprecatedNeutralVariant = "neutral";
type Variants = "typical" | "negative" | "subtle" | DeprecatedDefaultVariant | DeprecatedNeutralVariant;
export interface StyledLinkProps {
/** @deprecated The disabled state of the link. This prop is deprecated and will soon be removed. */
disabled?: boolean;
/** Specifies when the link underline should be displayed. */
underline?: "always" | "hover" | "never";
/** Which side of the link to the render the link. */
iconAlign?: "left" | "right";
/** Allows to create skip link */
isSkipLink?: boolean;
/** Allows link styling to be updated for light or dark backgrounds */
variant?: Variants;
hasFocus?: boolean;
/** Sets the correct link size */
linkSize?: "medium" | "large";
/** Sets the colour styling when component is rendered on a dark background */
inverse?: boolean;
/** @deprecated The 'isDarkBackground' prop in Link is deprecated and will soon be removed. Please use 'inverse' prop instead. */
isDarkBackground?: boolean;
}
interface PrivateStyledLinkProps {
hasContent: boolean;
isMenuItem?: boolean;
}
declare const StyledLink: import("styled-components").StyledComponent<"span", any, {
theme: object;
} & StyledLinkProps & PrivateStyledLinkProps, "theme">;
declare const StyledContent: import("styled-components").StyledComponent<"span", any, {}, never>;
export { StyledLink, StyledContent };