twenty/packages/twenty-docs/twenty-ui/input/toggle.mdx

42 lines
901 B
Text

---
title: Toggle
image: /images/user-guide/table-views/table.png
---
<Frame>
<img src="/images/user-guide/table-views/table.png" alt="Header" />
</Frame>
<Tabs>
<Tab title="Usage">
```jsx
import { Toggle } from "twenty-ui/input";
export const MyComponent = () => {
return (
<Toggle
value = {true}
onChange = {()=>console.log('On Change event')}
color="green"
toggleSize = "medium"
/>
);
};
```
</Tab>
<Tab title="Props">
| Props | Type | Description | Default |
|-------|------|-------------|--------|
| value | boolean | The current state of the toggle | `false` |
| onChange | function | Callback function triggered when the toggle state changes | |
| color | string | Color of the toggle when it\ | s blue color |
| toggleSize | string | Size of the toggle, affecting both height and weight. Has two options: `small` and `medium` | medium |
</Tab>
</Tabs>