@patternfly/react-core
Version:
This library provides a set of common React components for use with the PatternFly reference implementation.
36 lines • 1.87 kB
TypeScript
import { Component } from 'react';
import { TooltipPosition } from '../../../components/Tooltip';
import { LabelProps } from '../../../components/Label';
import { OUIAProps } from '../../../helpers';
export interface ChipProps extends LabelProps, OUIAProps {
/** Badge to add to the chip. The badge will be rendered after the chip text. */
badge?: React.ReactNode;
/** Content rendered inside the chip text */
children?: React.ReactNode;
/** Aria Label for close button */
closeBtnAriaLabel?: string;
/** Additional classes added to the chip item */
className?: string;
/** Flag indicating if the chip is an overflow chip */
isOverflowChip?: boolean;
/** Flag indicating if chip is read only */
isReadOnly?: boolean;
/** Function that is called when clicking on the chip close button */
onClick?: (event: React.MouseEvent) => void;
/** @deprecated Component that will be used for chip. It is recommended that <button> or <li> are used when the chip is an overflow chip. */
component?: React.ReactNode;
/** Position of the tooltip which is displayed if text is longer */
tooltipPosition?: TooltipPosition | 'auto' | 'top' | 'bottom' | 'left' | 'right' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end' | 'right-start' | 'right-end';
/** Css property expressed in percentage or any css unit that overrides the default value of the max-width of the chip's text */
textMaxWidth?: string;
/** Value to overwrite the randomly generated data-ouia-component-id.*/
ouiaId?: number | string;
}
declare class Chip extends Component<ChipProps> {
static displayName: string;
constructor(props: ChipProps);
static defaultProps: ChipProps;
render(): import("react/jsx-runtime").JSX.Element;
}
export { Chip };
//# sourceMappingURL=Chip.d.ts.map