[**@twipped/hooks**](../../README.md) • **Docs**

***

# Type alias: ToggledState

> **ToggledState**\<\>: `object`

## Type parameters

## Type declaration

### get()

> **get**: () => `boolean`

#### Returns

`boolean`

### off()

> **off**: () => `void`

#### Returns

`void`

### on()

> **on**: () => `void`

#### Returns

`void`

### state

> **state**: `boolean`

### toggle()

> **toggle**: (`onoff`) => `boolean`

#### Parameters

• **onoff**: `boolean`

#### Returns

`boolean`

## Source

[hooks/useToggledState.js:11](https://github.com/Twipped/hooks/blob/main/hooks/useToggledState.js#L11)