@metamask/snaps-sdk
Version:
A library containing the core functionality for building MetaMask Snaps
38 lines • 1.36 kB
text/typescript
import type { RadioElement } from "./Radio.mjs";
import type { SnapsChildren } from "../../component.mjs";
/**
* The props of the {@link RadioGroup} component.
*
* @property name - The name of the dropdown. This is used to identify the
* state in the form data.
* @property value - The value of the radio group element.
* @property children - Radio options in form of <Radio> elements.
* @property disabled - Whether the radio group is disabled.
*/
type RadioGroupProps = {
name: string;
value?: string | undefined;
children: SnapsChildren<RadioElement>;
disabled?: boolean | undefined;
};
/**
* A RadioGroup component, used to display multiple choices, where only one can be chosen.
*
* @param props.name - The name of the dropdown. This is used to identify the
* state in the form data.
* @param props.value - The value of the radio group element.
* @param props.children - Radio options in form of <Radio> elements.
* @param props.disabled - Whether the radio group is disabled.
* @returns A RadioGroup element.
* @example
* <RadioGroup />
*/
export declare const RadioGroup: import("../../component.mjs").SnapComponent<RadioGroupProps, "RadioGroup">;
/**
* A RadioGroup element.
*
* @see RadioGroup
*/
export type RadioGroupElement = ReturnType<typeof RadioGroup>;
export {};
//# sourceMappingURL=RadioGroup.d.mts.map