📦 ionic-team / ionic-docs

📄 menu-toggle.md · 53 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53---
title: 'ion-menu-toggle'
---

import Props from '@ionic-internal/component-api/v7/menu-toggle/props.md';
import Events from '@ionic-internal/component-api/v7/menu-toggle/events.md';
import Methods from '@ionic-internal/component-api/v7/menu-toggle/methods.md';
import Parts from '@ionic-internal/component-api/v7/menu-toggle/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/menu-toggle/custom-props.mdx';
import Slots from '@ionic-internal/component-api/v7/menu-toggle/slots.md';

<head>
  <title>ion-menu-toggle: MenuToggle Component to Open/Close Menus</title>
  <meta
    name="description"
    content="The MenuToggle component can be used to toggle a menu open or closed—by default, it's only visible when the selected menu is active. Read more about usage."
  />
</head>

import EncapsulationPill from '@components/page/api/EncapsulationPill';

<EncapsulationPill type="shadow" />

The Menu Toggle component can be used to toggle a menu open or closed.

Menu toggles are only visible when the selected menu is enabled. If the menu is disabled or it's being presented as a split pane, the menu toggle will be hidden. To always display the menu toggle, the `autoHide` property can be set to `false`.

See the [menu](./menu#menu-toggle) documentation for more information.

## Properties

<Props />

## Events

<Events />

## Methods

<Methods />

## CSS Shadow Parts

<Parts />

## CSS Custom Properties

<CustomProps />

## Slots

<Slots />