@stihl-design-system/components
Version:
Welcome to the STIHL Design System react component library.
39 lines (38 loc) • 1.9 kB
TypeScript
import { CommonLinkProps } from '../LinkButton/LinkButton';
import { ActionLinkIconPosition, ActionLinkIconSize, ActionLinkIndentLevel, ActionLinkWeight } from './ActionLink.utils';
export interface ActionLinkProps extends Omit<CommonLinkProps, 'iconPosition' | 'theme'> {
/** Content within the link. */
children: React.ReactNode;
/** The position of the icon. `iconPosition='top'` requires either an `iconName` or `iconSource` to be set.
* @default 'left'
*/
iconPosition?: ActionLinkIconPosition;
/** Size of the icon. **Only available with `iconPosition='left'` and a custom `iconSource`**.
* @default 'large'
*/
iconSize?: ActionLinkIconSize;
/** Indent level of the link, used to align the link with other elements e.g. inside a DSAccordion. **Only available with `iconPosition='left'`**.
* @default 0
*/
indentLevel?: ActionLinkIndentLevel;
/** Enables the active state.
* @default false
*/
isActive?: boolean;
/** Number Indicator value displayed next to the label or above the icon. */
numberIndicatorValue?: string;
/** Stretches the link over the parent's width. **Only available with `iconPosition='left'`**.
* @default false
*/
stretched?: boolean;
/** Defines the weight. **Only available with `iconPosition='left'`**.
* @default 'normal'
*/
weight?: ActionLinkWeight;
}
/**
* Use the ActionLink component when you want the users to navigate to another internal or external page, used in the DSDrawer as a mobile menu or in the DSTopBar of the DSHeader.
*
* Design in Figma: [Action Item](https://www.figma.com/design/Ie2r0R9QwjEc7O3nrFbXhV/Web-Pattern-Library?node-id=6307-72257&t=6MyKQ9TAUdzZ1XaJ-4)
* */
export declare const DSActionLink: import('react').ForwardRefExoticComponent<ActionLinkProps & import('react').RefAttributes<HTMLAnchorElement>>;