UNPKG

1.45 kBTypeScriptView Raw
1import * as React from 'react';
2export type Props<Value = string> = {
3 /**
4 * Function to execute on selection change.
5 */
6 onValueChange: (value: Value) => void;
7 /**
8 * Value of the currently selected toggle button.
9 */
10 value: Value | null;
11 /**
12 * React elements containing toggle buttons.
13 */
14 children: React.ReactNode;
15};
16export declare const ToggleButtonGroupContext: React.Context<any>;
17/**
18 * Toggle group allows to control a group of toggle buttons.</br>
19 * It doesn't change the appearance of the toggle buttons. If you want to group them in a row, check out [ToggleButton.Row](ToggleButtonRow).
20 *
21 * ## Usage
22 * ```js
23 * import * as React from 'react';
24 * import { ToggleButton } from 'react-native-paper';
25 *
26 * const MyComponent = () => {
27 * const [value, setValue] = React.useState('left');
28 *
29 * return (
30 * <ToggleButton.Group
31 * onValueChange={value => setValue(value)}
32 * value={value}>
33 * <ToggleButton icon="format-align-left" value="left" />
34 * <ToggleButton icon="format-align-right" value="right" />
35 * </ToggleButton.Group>
36 * );
37 * };
38 *
39 * export default MyComponent;
40 *```
41 */
42declare const ToggleButtonGroup: {
43 <Value = string>({ value, onValueChange, children, }: Props<Value>): React.JSX.Element;
44 displayName: string;
45};
46export default ToggleButtonGroup;
47export { ToggleButtonGroup };
48//# sourceMappingURL=ToggleButtonGroup.d.ts.map
\No newline at end of file