@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
55 lines (54 loc) • 3.59 kB
TypeScript
import React, { ReactNode } from 'react';
/** A Button Custom HTML Element.
Based largely on the https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element .
* For more info on this Vivid element please visit https://vivid.deno.dev/components/vivid-foundation-button
* @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 {'submit' | 'reset' | 'button'} type - The button type. **attribute** `type`
* @param {HTMLButtonElement} control
* @param {'delegate'} _vividAriaBehaviour
* @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 VwcVividFoundationButton: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
autofocus?: boolean | undefined;
formId?: string | undefined;
formaction?: string | undefined;
formenctype?: string | undefined;
formmethod?: string | undefined;
formnovalidate?: boolean | undefined;
formtarget?: any;
type?: any;
control?: any;
_vividAriaBehaviour?: any;
value?: string | undefined;
currentValue?: any;
initialValue?: string | undefined;
disabled?: boolean | undefined;
name?: string | undefined;
required?: boolean | undefined;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcVividFoundationButton;