UNPKG

primereact

Version:

PrimeReact is an open source UI library for React featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with Prime

111 lines (105 loc) 3.07 kB
/** * * Tag component is used to categorize content. * * [Live Demo](https://www.primereact.org/tag) * * @module tag * */ import * as React from 'react'; import { ComponentHooks } from '../componentbase/componentbase'; import { PassThroughOptions } from '../passthrough'; import { IconType, PassThroughType } from '../utils'; export declare type TagPassThroughType<T> = PassThroughType<T, TagPassThroughMethodOptions>; /** * Custom passthrough(pt) option method. */ export interface TagPassThroughMethodOptions { props: TagProps; } /** * Custom passthrough(pt) options. * @see {@link TagProps.pt} */ export interface TagPassThroughOptions { /** * Uses to pass attributes to the root's DOM element. */ root?: TagPassThroughType<React.HTMLAttributes<HTMLSpanElement>>; /** * Uses to pass attributes to the icon's DOM element. */ icon?: TagPassThroughType<React.HTMLAttributes<HTMLSpanElement>>; /** * Uses to pass attributes to the value's DOM element. */ value?: TagPassThroughType<React.HTMLAttributes<HTMLSpanElement>>; /** * Used to manage all lifecycle hooks * @see {@link ComponentHooks} */ hooks?: ComponentHooks; } /** * Defines valid properties in Tag component. In addition to these, all properties of HTMLSpanElement can be used in this component. * @group Properties */ export interface TagProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, 'ref'> { /** * Value to display inside the tag. */ value?: React.ReactNode; /** * Severity type of the tag. * @defaultValue null */ severity?: 'success' | 'info' | 'warning' | 'danger' | 'secondary' | 'contrast' | null | undefined; /** * Whether the corners of the tag are rounded. * @defaultValue false */ rounded?: boolean | undefined; /** * Icon of the tag to display next to the value. */ icon?: IconType<TagProps> | undefined; /** * Used to get the child elements of the component. * @readonly */ children?: React.ReactNode | undefined; /** * Uses to pass attributes to DOM elements inside the component. * @type {TagPassThroughOptions} */ pt?: TagPassThroughOptions; /** * Used to configure passthrough(pt) options of the component. * @type {PassThroughOptions} */ ptOptions?: PassThroughOptions; /** * When enabled, it removes component related styles in the core. * @defaultValue false */ unstyled?: boolean; } /** * **PrimeReact - Tag** * * _Tag component is used to categorize content._ * * [Live Demo](https://www.primereact.org/tag/) * --- --- * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png) * * @group Component */ export declare class Tag extends React.Component<TagProps, any> { /** * Used to get container element. * @return {HTMLSpanElement | null} Container element */ public getElement(): HTMLSpanElement | null; }