@momentum-ui/react-collaboration/src/components/Link/Link.types.ts

Cisco Momentum UI Framework for React Collaboration Applications

import type { CSSProperties, ReactNode } from 'react';
import type { AriaLinkProps } from '@react-types/link';
import type { Props as IconProps } from '../Icon/Icon.types';
import type { TooltipTypes } from '../Tooltip/Tooltip.types';
import type { PlacementType } from '../Popover/Popover.types';

export interface Props extends AriaLinkProps {
  /**
   * Custom id for overriding this component's CSS.
   */
  id?: string;

  /**
   * Custom style for overriding this component's CSS.
   */
  style?: CSSProperties;

  /**
   * Custom class to be able to override the component's CSS
   */
  className?: string;

  /**
   * Child components of this component. This prop replaces primaryText.
   */
  children?: ReactNode;

  /**
   * Whether or not this component is disabled.
   */
  disabled?: boolean;

  /**
   * Whether or not this component has inverted theme colors.
   */
  inverted?: boolean;

  /**
   * title to use for this component.
   */
  title?: string;

  /**
   * whether or not this component has icon【default icon name = pop-out】 in the right
   * icon display needed tooltipContent
   */
  hasExternalLinkIcon?: boolean;

  /**
   * icon props (scale and autoscale)
   * for the externalLinkIcon
   */
  externalLinkIconProps?: Pick<IconProps, 'scale' | 'autoScale'>;

  /**
   * Used for tooltip content that gets triggered when the link is hovered; e.g 'Opens a new tab'
   */
  tooltipContent?: string;

  /**
   * Determines whether the tooltip is the description or the label of the trigger component, or none
   * Defaults to 'description'
   * `label`、`description`、`none`
   */
  tooltipType?: TooltipTypes;

  /**
   * Determines the placement of the tooltip
   * Defaults to 'bottom'
   */
  tooltipPlacement?: PlacementType;

  /**
   * tabIndex for <a> tag
   */
  tabIndex?: number;
}