NavBarContainer.onsplittoggle event

[NavBarContainer is no longer available for use as of Windows Library for JavaScript (WinJS) 4.2. Instead, use SplitViewCommand. ]

Occurs when the splitButton of a child NavBarCommand is opened or closed. A split button is toggled when the user navigates to another page or opens another split button.

Syntax

<div 
    data-win-control="WinJS.UI.NavBarContainer" 
    data-win-options="{onsplittoggle : handler}">
</div>
function handler(eventInfo) { /* Your code */ }
 
// addEventListener syntax
navBarContainer.addEventListener("splittoggle", handler);
navBarContainer.removeEventListener("splittoggle", handler);

Event information

Synchronous No
Bubbles Yes
Cancelable Yes

 

Event handler parameters

  • eventInfo
    Type: CustomEvent**

    An object that contains information about the event. The detail property of this object contains the following sub-properties:

    • detail.opened
      A Boolean value that's true if the button that raised this event is open or false if it's closed.

    • detail.index
      The index of the NavBarCommand that triggered this event.

    • detail.navbarcommand
      The NavBarCommand object that triggered this event.

    • detail.data
      If it exists, the data item that generated the NavBarCommand that triggered this event.

Requirements

Minimum WinJS version

WinJS 2.0

Namespace

WinJS.UI

See also

NavBarContainer

NavBar

NavBarCommand

BackButton

AppBar

Your first app - Part 3: PageControl objects and navigation

Navigating between pages (HTML)

Adding app bars

Adding nav bars

HTML AppBar control sample

HTML NavBar control sample

Navigation and navigation history sample

Designers

Command patterns

Navigation patterns

Guidelines for app bars

Bottom app bar

Top app bar