Version: v8

ion-menu

メニューコンポーネントは、現在のビューの横からスライドしてくるナビゲーションドロワーです。デフォルトでは、開始側を使用し、LTRの場合は左から、RTLの場合は右からスライドさせますが、サイドをオーバーライドすることができます。メニューの表示はモードによって異なりますが、表示タイプは利用可能なメニュータイプのいずれかに変更することができます。

メニュー要素はルートコンテンツ要素の兄弟要素でなければなりません。コンテンツにはいくつでもメニューを付けることができる。これらのメニューはテンプレートから制御するか、MenuControllerを使用してプログラムで制御することができます。

基本的な使い方

menu toggle コンポーネントを使用して、メニューを開いたり閉じたりするカスタムボタンを作成することができます。

typeプロパティは、アプリケーションでのメニューの表示方法をカスタマイズするために使用することができます。

メニューはデフォルトでは"start"側に表示されます。左から右へ移動するアプリでは左側に、右から左へ移動するアプリでは右側に表示されます。メニューは"start"の反対側である"end"側に表示させることもできます。

アプリ内で両サイドのメニューが必要な場合、 MenuController の open メソッドに side の値を渡すことでメニューを開くことができます。sideが指定されない場合は、"start"側のメニューが開かれる。MenuController` を使用した例については、下記の複数メニューセクションを参照ください。

複数メニュー

同じサイドに複数のメニューが存在する場合、サイドではなくIDで参照する必要があります。そうしないと、間違ったメニューがアクティブになる可能性がある。

テーマ

CSS Shadow Parts

Interfaces

MenuCustomEvent

必須ではありませんが、このコンポーネントから発行される Ionic イベントでより強く型付けを行うために、CustomEvent インターフェースの代わりにこのインターフェースを使用することが可能です。

interface MenuCustomEvent<T = any> extends CustomEvent {
  detail: T;
  target: HTMLIonMenuElement;
}

プロパティ

contentId

Description	The `id` of the main content. When using a router this is typically `ion-router-outlet`. When not using a router, this is typically your main view's `ion-content`. This is not the id of the `ion-content` inside of your `ion-menu`.
Attribute	`content-id`
Type	`string ｜ undefined`
Default	`undefined`

disabled

Description	`true`の場合、メニューは無効化される。
Attribute	`disabled`
Type	`boolean`
Default	`false`

maxEdgeStart

Description	The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered.
Attribute	`max-edge-start`
Type	`number`
Default	`50`

menuId

Description	メニューのIDです。
Attribute	`menu-id`
Type	`string ｜ undefined`
Default	`undefined`

side

Description	メニューがビューのどの側に配置されるべきか。
Attribute	`side`
Type	`"end" ｜ "start"`
Default	`'start'`

swipeGesture

Description	`true`の場合、スワイプによるメニュー操作が有効になる。
Attribute	`swipe-gesture`
Type	`boolean`
Default	`true`

type

Description	The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`.
Attribute	`type`
Type	`"overlay" ｜ "push" ｜ "reveal" ｜ undefined`
Default	`undefined`

イベント

Name	Description	Bubbles
`ionDidClose`	メニューが閉じられたときに発行されます。	`true`
`ionDidOpen`	メニューが開いているときに発行されます。	`true`
`ionWillClose`	メニューが閉じられようとするときに発行されます。	`true`
`ionWillOpen`	メニューが開かれようとするときに発行されます。	`true`

メソッド

close

Description	Closes the menu. If the menu is already closed or it can't be closed, it returns `false`.
Signature	`close(animated?: boolean, role?: string) => Promise<boolean>`
Parameters	animated: If `true`, the menu will animate when closing. If `false`, the menu will close instantly without animation. Defaults to `true`. role: The role of the element that is closing the menu. This can be useful in a button handler for determining which button was clicked to close the menu. Some examples include: `"cancel"`, `"destructive"`, `"selected"`, and `"backdrop"`.

isActive

Description	Returns `true` if the menu is active. A menu is active when it can be opened or closed, meaning it's enabled and it's not part of a `ion-split-pane`.
Signature	`isActive() => Promise<boolean>`

isOpen

Description	メニューが開いている場合は `true` を返します。
Signature	`isOpen() => Promise<boolean>`

open

Description	Opens the menu. If the menu is already open or it can't be opened, it returns `false`.
Signature	`open(animated?: boolean) => Promise<boolean>`
Parameters	animated: If `true`, the menu will animate when opening. If `false`, the menu will open instantly without animation. Defaults to `true`.

setOpen

Description	Opens or closes the menu. If the operation can't be completed successfully, it returns `false`.
Signature	`setOpen(shouldOpen: boolean, animated?: boolean, role?: string) => Promise<boolean>`
Parameters	shouldOpen: If `true`, the menu will open. If `false`, the menu will close. animated: If `true`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. role: The role of the element that is closing the menu.

toggle

Description	Toggles the menu. If the menu is already open, it will try to close, otherwise it will try to open it. If the operation can't be completed successfully, it returns `false`.
Signature	`toggle(animated?: boolean) => Promise<boolean>`
Parameters	animated: If `true`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. Defaults to `true`.

CSS Shadow Parts

Name	Description
`backdrop`	メニューを開いているときに、メインコンテンツの上に表示される背景です。
`container`	メニューの内容を格納するコンテナです。

CSSカスタムプロパティ

Name	Description
`--background`	メニューの背景
`--height`	メニューの高さ
`--max-height`	メニューの最大の高さ
`--max-width`	メニューの最大幅
`--min-height`	メニューの高さの最小値
`--min-width`	メニューの最小幅
`--width`	メニューの幅

Name	Description
`--background`	メニューの背景
`--height`	メニューの高さ
`--max-height`	メニューの最大の高さ
`--max-width`	メニューの最大幅
`--min-height`	メニューの高さの最小値
`--min-width`	メニューの最小幅
`--width`	メニューの幅

Slots

No slots available for this component.

ion-menu

基本的な使い方

Menu Toggle

Menu Types

Menu Sides

複数メニュー

テーマ

CSS Shadow Parts

Interfaces

MenuCustomEvent

プロパティ

contentId

disabled

maxEdgeStart

menuId

side

swipeGesture

type

イベント

メソッド

close

isActive

isOpen

open

setOpen

toggle

CSS Shadow Parts

CSSカスタムプロパティ

Slots

Contents

基本的な使い方​

Menu Toggle​

Menu Types​

Menu Sides​

複数メニュー​

テーマ​

CSS Shadow Parts​

Interfaces​

MenuCustomEvent​

プロパティ​

contentId​

disabled​

maxEdgeStart​

menuId​

side​

swipeGesture​

type​

イベント​

メソッド​

close​

isActive​

isOpen​

open​

setOpen​

toggle​

CSS Shadow Parts​

CSSカスタムプロパティ​

Slots​

Contents

基本的な使い方

Menu Toggle

Menu Types

Menu Sides

複数メニュー

テーマ

CSS Shadow Parts

Interfaces

MenuCustomEvent

プロパティ

contentId

disabled

maxEdgeStart

menuId

side

swipeGesture

type

イベント

メソッド

close

isActive

isOpen

open

setOpen

toggle

CSS Shadow Parts

CSSカスタムプロパティ

Slots