carbon-react 106.0.2 → 106.0.3

package/esm/components/link/link.component.d.ts

@@ -1,3 +1,38 @@
-export default Link;
-declare const Link: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from "react";
+import { IconType } from "components/icon/icon";
+export interface LinkProps extends React.AriaAttributes {
+    /** The disabled state of the link. */
+    disabled?: boolean;
+    /** An href for an anchor tag. */
+    href?: string;
+    /** An icon to display next to the link. */
+    icon?: IconType;
+    /** Which side of the link to the render the link. */
+    iconAlign?: "left" | "right";
+    /** Function called when the mouse is clicked. */
+    onClick?: (ev: React.MouseEvent<HTMLAnchorElement> | React.MouseEvent<HTMLButtonElement> | React.KeyboardEvent<HTMLAnchorElement> | React.KeyboardEvent<HTMLButtonElement>) => void;
+    /** Function called when a key is pressed. */
+    onKeyDown?: (ev: React.KeyboardEvent<HTMLAnchorElement> | React.KeyboardEvent<HTMLButtonElement>) => void;
+    /** Function called when a mouse down event triggers. */
+    onMouseDown?: (ev: React.MouseEvent<HTMLAnchorElement> | React.MouseEvent<HTMLButtonElement>) => void;
+    /** Whether to include the link in the tab order of the page */
+    tabbable?: boolean;
+    /** A message to display as a tooltip to the link. */
+    tooltipMessage?: string;
+    /** Positions the tooltip with the link. */
+    tooltipPosition?: "bottom" | "left" | "right" | "top";
+    /** Child content to render in the link. */
+    children?: React.ReactNode;
+    /** Classes to apply to the component. */
+    className?: string;
+    /** Target property in which link should open ie: _blank, _self, _parent, _top */
+    target?: string;
+    /** Aria label for accessibility purposes */
+    ariaLabel?: string;
+    /** Allows to create skip link */
+    isSkipLink?: boolean;
+    /** allows to set rel property in <a> tag */
+    rel?: string;
+}
+export declare const Link: React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLLinkElement | HTMLButtonElement>>;
+export default Link;