@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
30 lines (29 loc) • 1.46 kB
TypeScript
import React, { ReactNode } from 'react';
import '@vonage/vwc-badge';
/** Represents a badge custom element.
badge is a label that holds small amounts of information. A badge can be used to display unread notifications, or to label a block of text. Badges don’t work for navigation because they can't include a hyperlink.
* @param {BadgeConnotation | undefined} connotation attribute: <VwcBadge connotation />
* @param {BadgeShape | undefined} shape attribute: <VwcBadge shape />
* @param {BadgeLayout | undefined} layout attribute: <VwcBadge layout />
* @param {boolean} dense attribute: <VwcBadge dense />
* @param {boolean} enlarged attribute: <VwcBadge enlarged />
* @param {string | undefined} text attribute: <VwcBadge text />
* @param {string | undefined} icon attribute: <VwcBadge icon />
* @param {string | undefined} iconTrailing attribute: <VwcBadge iconTrailing />
*/
declare const VwcBadge: (props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
connotation?: any;
shape?: any;
layout?: any;
dense?: boolean | undefined;
enlarged?: boolean | undefined;
text?: string | undefined;
icon?: string | undefined;
iconTrailing?: string | undefined;
}) => JSX.Element;
export default VwcBadge;