Context Menu

The open state of the menu.

A callback that is fired when the menu's open state changes.

The reading direction of the app.

The children content to render.

Whether or not the menu trigger is disabled.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

The open state of the menu or submenu the element controls or belongs to.

Present on the trigger element.

The preferred side of the anchor to render the floating element against when open. Will be reversed when collisions occur.

The distance in pixels from the anchor to the floating element.

The preferred alignment of the anchor to render the floating element against when open. This may change when collisions occur.

The distance in pixels from the anchor to the floating element.

The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision.

When true, overrides the side and align options to prevent collisions with the boundary edges.

A boundary element or array of elements to check for collisions against.

The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision.

The sticky behavior on the align axis. 'partial' will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst 'always' will keep the content in the boundary regardless.

When true, hides the content when it is detached from the DOM. This is useful for when you want to hide the content when the user scrolls away.

The strategy to use when updating the position of the content. When 'optimized' the content will only be repositioned when the trigger is in the viewport. When 'always' the content will be repositioned whenever the position changes.

The positioning strategy to use for the floating element. When 'fixed' the element will be positioned relative to the viewport. When 'absolute' the element will be positioned relative to the nearest positioned ancestor.

When true, prevents the body from scrolling when the content is open. This is useful when you want to use the content as a modal.

Callback fired when an escape keydown event occurs in the floating content. You can call event.preventDefault() to prevent the default behavior of handling the escape keydown event.

The behavior to use when an escape keydown event occurs in the floating content. 'close' will close the content immediately. 'ignore' will prevent the content from closing. 'defer-otherwise-close' will defer to the parent element if it exists, otherwise it will close the content. 'defer-otherwise-ignore' will defer to the parent element if it exists, otherwise it will ignore the interaction.

Callback fired when an outside interaction event completes, which is either a pointerup, mouseup, or touchend event, depending on the user's input device. You can call event.preventDefault() to prevent the default behavior of handling the outside interaction.

Callback fired when an outside interaction event starts, which is either a pointerdown, mousedown, or touchstart event, depending on the user's input device. You can call event.preventDefault() to prevent the continuation of the outside interaction.

Callback fired when focus leaves the dismissable layer. You can call event.preventDefault() to prevent the default behavior on focus leaving the layer.

The behavior to use when an interaction occurs outside of the floating content. 'close' will close the content immediately. 'ignore' will prevent the content from closing. 'defer-otherwise-close' will defer to the parent element if it exists, otherwise it will close the content. 'defer-otherwise-ignore' will defer to the parent element if it exists, otherwise it will ignore the interaction.

Event handler called when auto-focusing the content as it is mounted. Can be prevented.

Event handler called when auto-focusing the content as it is destroyed. Can be prevented.

Whether or not to trap the focus within the content when open.

When true, prevents the text selection from overflowing the bounds of the element.

The reading direction of the app.

Whether or not to forcefully mount the content. This is useful if you want to use Svelte transitions or another animation library for the content.

Whether or not the context menu should loop through items when reaching the end.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

The open state of the menu or submenu the element controls or belongs to.

Present on the content element.

The transform origin of the context menu content element.

The available width of the context menu content element.

The available height of the context menu content element.

The width of the context menu trigger element.

The height of the context menu trigger element.

Whether or not the menu item is disabled.

The text value of the checkbox menu item. This is used for typeahead.

A callback that is fired when the menu item is selected.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

Present when the menu item is highlighted.

Present when the menu item is disabled.

Present on the item element.

Whether or not the checkbox menu item is disabled. Disabled items cannot be interacted with and are skipped when navigating with the keyboard.

The checkbox menu item's checked state.

A callback that is fired when the checkbox menu item's checked state changes.

The text value of the checkbox menu item. This is used for typeahead.

A callback that is fired when the menu item is selected.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

Present when the menu item is highlighted.

Present when the menu item is disabled.

The checkbox menu item's checked state.

The value of the currently checked radio menu item.

A callback that is fired when the radio group's value changes.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

Present on the radio group element.

The value of the radio item. When checked, the parent RadioGroup's value will be set to this value.

Whether or not the radio menu item is disabled. Disabled items cannot be interacted with and are skipped when navigating with the keyboard.

The text value of the checkbox menu item. This is used for typeahead.

A callback that is fired when the menu item is selected.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

Present when the menu item is highlighted.

Present when the menu item is disabled.

The radio menu item's checked state.

The value of the radio item.

Present on the radio item element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

The orientation of the separator.

Present on the separator element.

The width of the arrow in pixels.

The height of the arrow in pixels.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

The open state of the menu or submenu the element controls or belongs to.

Present on the arrow element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

Present on the group element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

Present on the group label element.

The open state of the submenu.

A callback that is fired when the submenu's open state changes.

The children content to render.

Whether or not the submenu trigger is disabled.

The text value of the checkbox menu item. This is used for typeahead.

A callback that is fired when the menu item is selected.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

Present when the menu item is highlighted.

Present when the menu item is disabled.

The open state of the menu or submenu the element controls or belongs to.

Present on the submenu trigger element.

The preferred side of the anchor to render the floating element against when open. Will be reversed when collisions occur.

The distance in pixels from the anchor to the floating element.

The preferred alignment of the anchor to render the floating element against when open. This may change when collisions occur.

The distance in pixels from the anchor to the floating element.

The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision.

When true, overrides the side and align options to prevent collisions with the boundary edges.

A boundary element or array of elements to check for collisions against.

The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision.

The sticky behavior on the align axis. 'partial' will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst 'always' will keep the content in the boundary regardless.

When true, hides the content when it is detached from the DOM. This is useful for when you want to hide the content when the user scrolls away.

The strategy to use when updating the position of the content. When 'optimized' the content will only be repositioned when the trigger is in the viewport. When 'always' the content will be repositioned whenever the position changes.

The positioning strategy to use for the floating element. When 'fixed' the element will be positioned relative to the viewport. When 'absolute' the element will be positioned relative to the nearest positioned ancestor.

When true, prevents the body from scrolling when the content is open. This is useful when you want to use the content as a modal.

Callback fired when an escape keydown event occurs in the floating content. You can call event.preventDefault() to prevent the default behavior of handling the escape keydown event.

The behavior to use when an escape keydown event occurs in the floating content. 'close' will close the content immediately. 'ignore' will prevent the content from closing. 'defer-otherwise-close' will defer to the parent element if it exists, otherwise it will close the content. 'defer-otherwise-ignore' will defer to the parent element if it exists, otherwise it will ignore the interaction.

Callback fired when an outside interaction event completes, which is either a pointerup, mouseup, or touchend event, depending on the user's input device. You can call event.preventDefault() to prevent the default behavior of handling the outside interaction.

Callback fired when an outside interaction event starts, which is either a pointerdown, mousedown, or touchstart event, depending on the user's input device. You can call event.preventDefault() to prevent the continuation of the outside interaction.

Callback fired when focus leaves the dismissable layer. You can call event.preventDefault() to prevent the default behavior on focus leaving the layer.

The behavior to use when an interaction occurs outside of the floating content. 'close' will close the content immediately. 'ignore' will prevent the content from closing. 'defer-otherwise-close' will defer to the parent element if it exists, otherwise it will close the content. 'defer-otherwise-ignore' will defer to the parent element if it exists, otherwise it will ignore the interaction.

Event handler called when auto-focusing the content as it is mounted. Can be prevented.

Event handler called when auto-focusing the content as it is destroyed. Can be prevented.

Whether or not to trap the focus within the content when open.

Whether or not to forcefully mount the content. This is useful if you want to use Svelte transitions or another animation library for the content.

When true, prevents the text selection from overflowing the bounds of the element.

The reading direction of the app.

Whether or not to loop through the menu items in when navigating with the keyboard.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See delegation docs for more information.

The open state of the menu or submenu the element controls or belongs to.

Present on the submenu content element.