@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
35 lines • 990 B
TypeScript
import * as React from 'react';
import { ErrorType } from '@workday/canvas-kit-react/common';
export interface SwitchProps {
/**
* If true, set the Switch to the on state.
* @default false
*/
checked?: boolean;
/**
* If true, set the Switch to the disabled state.
* @default false
*/
disabled?: boolean;
/**
* The HTML `id` of the underlying checkbox input element.
* @default A uniquely generated id
*/
id?: string;
/**
* The function called when the Switch state changes.
*/
onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
/**
* The value of the Switch.
*/
value?: string;
/**
* The type of error associated with the Switch (if applicable).
*/
error?: ErrorType;
}
export declare const Switch: import("@workday/canvas-kit-react/common").ElementComponent<"input", SwitchProps> & {
ErrorType: typeof ErrorType;
};
//# sourceMappingURL=Switch.d.ts.map