fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
40 lines
645 B
Plaintext
40 lines
645 B
Plaintext
---
|
|
title: "useToggleState"
|
|
description: ""
|
|
component: true
|
|
---
|
|
|
|
|
|
This is a simple hook that can be used to keep track of a boolean value and toggle between its two states.
|
|
|
|
It can be useful to, for example, display or hide the same `FocusModal` component
|
|
via multiple triggers, for example, in a table.
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { useToggleState } from "@medusajs/ui"
|
|
```
|
|
|
|
```tsx
|
|
const [state, open, close, toggle] = useToggleState()
|
|
```
|
|
|
|
## API Reference
|
|
|
|
---
|
|
|
|
### Call Signature
|
|
|
|
`useToggleState(initial: boolean = false)`
|
|
|
|
### Returns
|
|
|
|
<HookValues hook="useToggleState" />
|
|
|
|
## Examples
|
|
|
|
---
|
|
|
|
<ComponentExample name="use-toggle-state-demo" />
|