UNPKG

@kvaser/canking-api

Version:

CanKing API to communicate with the CanKing service using Node.js.

36 lines (35 loc) 1.14 kB
/** * This module includes a radio button UI control. * * To be able to use these controls the CanKingDataProvider component must be present in the * component tree above your component. Normally the CanKingDataProvider is added * at the root of the component tree. * * @packageDocumentation */ import { SxProps, Theme } from '@mui/material'; import { JSX } from 'react'; /** * Properties of the RadioControl React component. */ export interface RadioControlProps { /** The component id. */ id?: string; /** The label to be displayed next to the radio button. */ label: string; /** The value that this radio button represents. */ value: string; /** Set to true to disable this control. */ disabled?: boolean; /** The component size. */ size?: 'small' | 'medium'; /** Optional sx properties. */ sx?: SxProps<Theme>; } /** * Creates a radio button control. * @param props - Component properties. * @returns The RadioControl React component. */ declare function RadioControl({ id, label, value, disabled, size, sx, }: RadioControlProps): JSX.Element; export default RadioControl;