@engie-group/fluid-design-system-react/lib/components/tag/NJTag.d.ts

Fluid Design System React

import React from 'react';
import { TBrandExtendedColorVariants } from '../../global';
export declare const NJTag: React.ForwardRefExoticComponent<ITagProps & React.RefAttributes<HTMLDivElement>>;
export type TagSize = 'xs' | 'sm' | 'md' | 'lg';
export interface ITagProps {
    /**
     * Tag label
     */
    label: string;
    /**
     * Tag href. If set, tag renders a link
     */
    href?: string;
    /**
     * Link target
     */
    target?: string;
    /**
     * Tag theme variant
     */
    variant?: TBrandExtendedColorVariants;
    /**
     * Tag size
     */
    size?: TagSize;
    /**
     * Tag iconName
     */
    iconName?: string;
    /**
     * Whether tag is disabled or not
     */
    isDisabled?: boolean;
    /**
     * Whether tag has a close icon or not
     */
    hasClose?: boolean;
    /**
     * Label for the close button, if present
     * @example "Remove [tag name]"
     */
    closeAriaLabel?: string;
    /**
     * If set, tag renders a button
     */
    onClick?: React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement>;
    /**
     * Event when tag is closed. Focus must be set to either previous tag, next tag or any relevant element.
     */
    onClose?: React.MouseEventHandler<HTMLElement>;
    /**
     * Whether tag is visible or not
     */
    isVisible?: boolean;
    className?: string;
}