@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
98 lines (97 loc) • 7.14 kB
TypeScript
import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcButton
* For more info on this Vivid element please visit https://vivid.deno.dev/components/button
* @param {string | undefined} icon **attribute** `icon`
* @param {boolean | undefined} disabled **attribute** `disabled`
* @param {string | undefined} type **attribute** `type`
* @param {boolean | undefined} icon-trailing
* @param {string} title - Specifies extra information about the button. This information is typically used by browsers to display a tooltip. **attribute** `title`
* @param {ButtonConnotation | undefined} connotation - The connotation the button should have. **attribute** `connotation`
* @param {ButtonShape | undefined} shape - The shape the button should have. **attribute** `shape`
* @param {ButtonAppearance | undefined} appearance - The appearance the button should have. **attribute** `appearance`
* @param {ButtonSize | undefined} size - The size the button should have. **attribute** `size`
* @param {boolean} stacked - Indicates the icon is stacked. **attribute** `stacked`
* @param {boolean} pending - Displays the button in pending state. **attribute** `pending`
* @param {boolean} dropdownIndicator - Display a chevron to indicate that the button opens a dropdown. **attribute** `dropdown-indicator`
* @param {boolean} active - Displays the button in active state. **attribute** `active`
* @param {string | undefined} label - Indicates the button's label. **attribute** `label`
* @param {boolean} iconTrailing - Indicates the icon affix alignment. **attribute** `icon-trailing`
* @param {string | undefined} icon - A decorative icon the custom element should have. **attribute** `icon`
* @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 {'submit' | 'reset' | 'button'} type - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information. **attribute** `type`
* @param {HTMLButtonElement} control - References the root element
* @param {'delegate'} _vividAriaBehaviour
* @param {boolean} autofocus - Determines if the element should receive document focus on page load. **attribute** `autofocus`
* @param {string} formId - The id of a form to associate the element to. **attribute** `form`
* @param {string} formaction - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details. **attribute** `formaction`
* @param {string} formenctype - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details. **attribute** `formenctype`
* @param {string} formmethod - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details. **attribute** `formmethod`
* @param {boolean} formnovalidate - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details. **attribute** `formnovalidate`
* @param {'_self' | '_blank' | '_parent' | '_top'} formtarget - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details. **attribute** `formtarget`
* @param {string} value - The current value of the element. **attribute** `current-value`
* @param currentValue
* @param {string} initialValue - The default value of the element. This value sets the `value` property
only when the `value` property has not been explicitly set. **attribute** `value`
* @param {boolean} disabled - Sets the element's disabled state. A disabled element will not be included during form submission. **attribute** `disabled`
* @param {string} name - The name of the element. This element's value will be surfaced during form submission under the provided name. **attribute** `name`
* @param {boolean} required - Require the field to be completed prior to form submission. **attribute** `required`
* @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 VwcButton: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
onClick?: ((event: SyntheticEvent) => void) | undefined;
icon?: string | undefined;
disabled?: any;
type?: string | undefined;
"icon-trailing"?: any;
title?: string | undefined;
connotation?: any;
shape?: any;
appearance?: any;
size?: any;
stacked?: boolean | undefined;
pending?: boolean | undefined;
dropdownIndicator?: boolean | undefined;
active?: boolean | undefined;
label?: string | undefined;
iconTrailing?: boolean | undefined;
download?: string | undefined;
href?: string | undefined;
hreflang?: string | undefined;
ping?: string | undefined;
referrerpolicy?: string | undefined;
rel?: string | undefined;
target?: any;
control?: any;
_vividAriaBehaviour?: any;
autofocus?: boolean | undefined;
formId?: string | undefined;
formaction?: string | undefined;
formenctype?: string | undefined;
formmethod?: string | undefined;
formnovalidate?: boolean | undefined;
formtarget?: any;
value?: string | undefined;
currentValue?: any;
initialValue?: string | undefined;
name?: string | undefined;
required?: boolean | undefined;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcButton;