smart-webcomponents-react
Version:
[](https://jqwidgets.com/license/)
146 lines (145 loc) • 6.01 kB
TypeScript
import React from "react";
import { RadioButtonProperties } from "./../index";
import { Animation, CheckMode, ClickMode } from './../index';
export { RadioButtonProperties } from "./../index";
export { Animation, CheckMode, ClickMode } from './../index';
declare let Smart: any;
export { Smart };
export interface RadioButtonProps extends RadioButtonProperties {
className?: string;
style?: React.CSSProperties;
onChange?: ((event?: Event) => void) | undefined;
onCheckValue?: ((event?: Event) => void) | undefined;
onUncheckValue?: ((event?: Event) => void) | undefined;
onCreate?: ((event?: Event) => void) | undefined;
onReady?: ((event?: Event) => void) | undefined;
}
/**
The Radio Button component lets you add a radio button and assign it to a radio group. Users can select only one radio button at a time within a radio group
*/
export declare class RadioButton extends React.Component<React.HTMLAttributes<Element> & RadioButtonProps, any> {
private _id;
private nativeElement;
private componentRef;
get id(): string;
/** Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
* Property type: Animation | string
*/
get animation(): Animation | string;
set animation(value: Animation | string);
/** Sets or gets the check state.
* Property type: boolean
*/
get checked(): boolean;
set checked(value: boolean);
/** Sets or gets the part that toggles the element.
* Property type: CheckMode | string
*/
get checkMode(): CheckMode | string;
set checkMode(value: CheckMode | string);
/** Sets the click mode of the radio button.
* Property type: ClickMode | string
*/
get clickMode(): ClickMode | string;
set clickMode(value: ClickMode | string);
/** Enables or disables the ratio button.
* Property type: boolean
*/
get disabled(): boolean;
set disabled(value: boolean);
/** Sets or gets the widget's group name.
* Property type: string
*/
get groupName(): string;
set groupName(value: string);
/** Sets or gets the widget's innerHTML.
* Property type: string
*/
get innerHTML(): string;
set innerHTML(value: string);
/** Sets or gets the unlockKey which unlocks the product.
* Property type: string
*/
get unlockKey(): string;
set unlockKey(value: string);
/** Sets or gets the language. Used in conjunction with the property messages.
* Property type: string
*/
get locale(): string;
set locale(value: string);
/** Callback, related to localization module.
* Property type: any
*/
get localizeFormatFunction(): any;
set localizeFormatFunction(value: any);
/** Sets an object with string values, related to the different states of passwords strength.
* Property type: any
*/
get messages(): any;
set messages(value: any);
/** Sets or gets the widget's name.
* Property type: string
*/
get name(): string;
set name(value: string);
/** If the custom element is readonly, it cannot be interacted with.
* Property type: boolean
*/
get readonly(): boolean;
set readonly(value: boolean);
/** Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
* Property type: boolean
*/
get rightToLeft(): boolean;
set rightToLeft(value: boolean);
/** Determines the theme. Theme defines the look of the element
* Property type: string
*/
get theme(): string;
set theme(value: string);
/** If is set to true, the element cannot be focused.
* Property type: boolean
*/
get unfocusable(): boolean;
set unfocusable(value: boolean);
/** Sets or gets the widget's value.
* Property type: string
*/
get value(): string;
set value(value: string);
get properties(): string[];
/** This event is triggered when the widget is checked/unchecked.
* @param event. The custom event. Custom event was created with: event.detail( value, oldValue, changeType)
* value - A boolean value indicating the new state of the button ( checked or not ).
* oldValue - A boolean value indicating the previous state of the button ( checked or not ).
* changeType - A string flag indicating whether the change event was triggered via API or an event.
*/
onChange?: ((event?: Event) => void) | undefined;
/** This event is triggered when the widget is checked.
* @param event. The custom event. Custom event was created with: event.detail( changeType)
* changeType - A string flag indicating whether the change event was triggered via API or an event.
*/
onCheckValue?: ((event?: Event) => void) | undefined;
/** This event is triggered when the widget is unchecked.
* @param event. The custom event. Custom event was created with: event.detail( changeType)
* changeType - A string flag indicating whether the change event was triggered via API or an event.
*/
onUncheckValue?: ((event?: Event) => void) | undefined;
/** This event occurs, when the React component is created.
* @param event. The custom event. */
onCreate?: ((event?: Event) => void) | undefined;
/** This event occurs, when the React component is completely rendered.
* @param event. The custom event. */
onReady?: ((event?: Event) => void) | undefined;
get eventListeners(): string[];
constructor(props: any);
componentDidRender(initialize: boolean): void;
componentDidMount(): void;
componentDidUpdate(): void;
componentWillUnmount(): void;
render(): React.ReactElement<{
ref: any;
suppressHydrationWarning: boolean;
}, string | React.JSXElementConstructor<any>>;
}
export default RadioButton;