Select Menu

The SelectMenu component provides advanced support for navigation, filtering, and more. Any menu can make use of JavaScript-enabled live filtering, selected states, tabbed lists, and keyboard navigation with a bit of markup.

Basic example

Use a <details> element to toggle the Select Menu. The <summary> element can be styled in many ways. In the example below it's a .btn.

Add a .SelectMenu-header to house a clear title and a close button. Note that the close button is only shown on narrow screens (mobile).

Right aligned

In case the Select Menu should be aligned to the right, use SelectMenu right-0.

Selected state

Add a .SelectMenu-icon .octicon-check icon and it will show up when aria-checked="true" is set.

List items

The list of items is arguably the most important subcomponent within the menu. Build them out of anchors, buttons, or just about any interactive content. List items are also customizable with options for avatars, additional icons, and multiple lines of text. Use utility classes like mr-2, d-flex or float-right in case more custom styling is needed.

Divider

The Select Menu's list can be divided into multiple parts by adding a .SelectMenu-divider.

If the list is expected to get long, consider adding a .SelectMenu-filter input. Be sure to also include the .SelectMenu--hasFilter modifier class. On mobile devices it will add a fixed height and anchor the Select Menu to the top of the screen. This makes sure the filter input stays at the same position while typing.

Also consider adding a .SelectMenu-footer at the bottom. It can be used for additional information, but can also greatly improve the scrolling performance because the list doesn't need to be repainted due to the rounded corners.

Tabs

Sometimes you need two or more lists of items in your Select Menu, e.g. branches and tags. Select Menu lists can be tabbed with the addition of .SelectMenu-tabs above the menu.

Message

A SelectMenu-message can be used to show different kind of messages to a user. Use utility classes to further style the message.

Loading

When fetching large lists, consider showing a .SelectMenu-loading animation.

Blankslate

Sometimes a Select Menu needs to communicate a "blank slate" where there's no content in the menu's list. Usually these include a clear call to action to add said content to the list. Swap out the contents of a .SelectMenu-list with a .SelectMenu-blankslate and customize its contents as needed.

github.com usage

When adding the .SelectMenu component on github.com, use the <details-menu> element. It will :tophat: magically make the .SelectMenu work. Here a basic example:

<details class="details-reset details-overlay" id="my-select-menu">
<summary class="btn" title="Pick an item">
<span>Choose</span>
<span class="dropdown-caret"></span>
</summary>
<details-menu class="SelectMenu" role="menu">
<div class="SelectMenu-modal">
<header class="SelectMenu-header">
<span class="SelectMenu-title">My Select Menu</span>
<button class="SelectMenu-closeButton" type="button" data-toggle-for="my-select-menu">
<%= octicon("x", "aria-label": "Close menu") %>
</button>
</header>
</div>
<div class="SelectMenu-list">
<a class="SelectMenu-item" href="" role="menuitem">Item 1</a>
<a class="SelectMenu-item" href="" role="menuitem">Item 2</a>
<a class="SelectMenu-item" href="" role="menuitem">Item 3</a>
</div>
</details-menu>
</details>

If loading content should be deferred, use the <include-fragment> element:

<details-menu class="SelectMenu" src="/my-menu" preload>
<div class="SelectMenu-modal">
<include-fragment class="SelectMenu-loading" aria-label="Menu is loading">
<%= octicon("octoface", class: "anim-pulse", :height => 32) %>
</include-fragment>
</div>
</details-menu>

It will add a pulsing :octoface: icon while the content is loading.

Edit this page on GitHub
2 contributorssimuraicolebemis
Last edited by simurai on August 22, 2019