@patternfly/react-core/dist/js/components/Label/Label.d.ts

This library provides a set of common React components for use with the PatternFly reference implementation.

/// <reference types="react" />
import { TooltipPosition } from '../Tooltip';
export interface LabelProps extends React.HTMLProps<HTMLSpanElement> {
    /** Content rendered inside the label. */
    children?: React.ReactNode;
    /** Additional classes added to the label. */
    className?: string;
    /** Color of the label. */
    color?: 'blue' | 'teal' | 'green' | 'orange' | 'purple' | 'red' | 'orangered' | 'grey' | 'yellow';
    /** Variant of the label. */
    variant?: 'outline' | 'filled' | 'overflow' | 'add';
    /** Status of the label with a respective icon and color. Overrides the color set by the color property. */
    status?: 'success' | 'warning' | 'danger' | 'info' | 'custom';
    /** Flag indicating the label is compact. */
    isCompact?: boolean;
    /** Flag indicating the label is disabled. Works only on clickable labels, so either href or onClick props must be passed in. */
    isDisabled?: boolean;
    /** Flag indicating the label is editable. */
    isEditable?: boolean;
    /** Flag indicating the label is clickable. This flag will automatically be set if a href is passed, or if an onClick handler is passed and the label is not an overflow or add variant. This should be manually set when using the render prop. */
    isClickable?: boolean;
    /** Additional props passed to the editable label text div. Optionally passing onInput and onBlur callbacks will allow finer custom text input control. */
    editableProps?: any;
    /** Callback when an editable label completes an edit. */
    onEditComplete?: (event: MouseEvent | KeyboardEvent, newText: string) => void;
    /** Callback when an editable label cancels an edit. */
    onEditCancel?: (event: KeyboardEvent, previousText: string) => void;
    /** The max width of the label before it is truncated. Can be any valid CSS unit, such as '100%', '100px', or '16ch'. */
    textMaxWidth?: string;
    /** Position of the tooltip which is displayed if text is truncated */
    tooltipPosition?: TooltipPosition | 'auto' | 'top' | 'bottom' | 'left' | 'right' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end' | 'right-start' | 'right-end';
    /** Icon added to the left of the label text. Overrides the icon set by the status property. */
    icon?: React.ReactNode;
    /** Close click callback for removable labels. If present, label will have a close button. */
    onClose?: (event: React.MouseEvent) => void;
    /** Node for custom close button. */
    closeBtn?: React.ReactNode;
    /** Aria label for close button */
    closeBtnAriaLabel?: string;
    /** Additional properties for the default close button. */
    closeBtnProps?: any;
    /** Href for a label that is a link. If present, the label will change to an anchor element. This should not be passed in if the onClick prop is also passed in. */
    href?: string;
    /** Callback for when the label is clicked. This should not be passed in if the href or isEditable props are also passed in. */
    onClick?: (event: React.MouseEvent) => void;
    /** Forwards the label content and className to rendered function.  Use this prop for react router support.*/
    render?: ({ className, content, componentRef }: {
        className: string;
        content: React.ReactNode;
        componentRef: any;
    }) => React.ReactNode;
}
export declare const Label: React.FunctionComponent<LabelProps>;
//# sourceMappingURL=Label.d.ts.map