@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
55 lines (54 loc) • 3.69 kB
TypeScript
import React, { ReactNode } from 'react';
/** VwcAvatar
* For more info on this Vivid element please visit https://vivid.deno.dev/components/avatar
* @param {AvatarConnotation | undefined} connotation - The connotation the avatar should have. **attribute** `connotation`
* @param {AvatarShape | undefined} shape - The shape the avatar should have. **attribute** `shape`
* @param {AvatarAppearance | undefined} appearance - The appearance the avatar should have. **attribute** `appearance`
* @param {AvatarSize | undefined} size - The size the avatar should have. **attribute** `size`
* @param {string | undefined} icon **attribute** `icon`
* @param {string | undefined} initials - avatar name **attribute** `initials`
* @param {boolean} clickable - Indicates whether avatar should be a clickable <button> element. **attribute** `clickable`
* @param {string | undefined} download - Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `download`
* @param {string | undefined} href - The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `href`
* @param {string | undefined} hreflang - Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `hreflang`
* @param {string | undefined} ping - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `ping`
* @param {string | undefined} referrerpolicy - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `referrerpolicy`
* @param {string | undefined} rel - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `rel`
* @param {'_self' | '_blank' | '_parent' | '_top' | undefined} target - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `target`
* @param {string | undefined} type - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `type`
* @param {HTMLAnchorElement} control - References the root element
* @param {'delegate'} _vividAriaBehaviour
* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
* @param {string} componentName - Core component name, without prefix
*/
declare const VwcAvatar: {
(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;
appearance?: any;
size?: any;
icon?: string | undefined;
initials?: string | undefined;
clickable?: boolean | undefined;
download?: string | undefined;
href?: string | undefined;
hreflang?: string | undefined;
ping?: string | undefined;
referrerpolicy?: string | undefined;
rel?: string | undefined;
target?: any;
type?: string | undefined;
control?: any;
_vividAriaBehaviour?: any;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcAvatar;