Skip to content
This repository was archived by the owner on Sep 30, 2025. It is now read-only.
This repository was archived by the owner on Sep 30, 2025. It is now read-only.

Add Searchable Listbox to Page and IndexTable's actions #8686

@MitchLillie

Description

@MitchLillie

Searchable Listbox for Page and IndexTable actions

Actions are used to interact with resources as well as launch apps. Adding a search box and a "show {n} more" link allows Merchants to better find the action they're looking for.

Required components

The Page component will depend on the Listbox and Text field components.

The IndexTable component will also depend on the Listbox and Text field components.

Examples

Note: All of the below apply to both Page and IndexTable. The component that activates them is the "More actions" button for Page and the kebab button (when items have been selected) for IndexTable.

Searchable listbox with action sections

This is shown when:

  • there are built-in actions in addition to app actions (shows different sections)
    • Note: on narrower screens, built-in actions become collapsed into the listbox
  • there are more than 10 total items (shows the searchbar)
  • there are 10 or fewer items in a specific section (does not show the "show all {n} actions")

Wiregram Dropdown Menu (2)

Searchable list

This is shown when:

  • there are only app actions to display, no built-in (does not show different sections)
    • Note: on narrower screens, built-in actions become collapsed into the listbox
  • there are more than 10 total items (shows the searchbar)
  • there are more than 10 items in a specific section (shows the "show all {n} actions")

Wiregram Dropdown Menu (1)

App actions list

This is shown when:

  • there are only app actions to display, no built-in (does not show different sections)
    • Note: on narrower screens, built-in actions become collapsed into the listbox
  • there are 10 or fewer total items (does not show the searchbar)
  • there are 10 or fewer items in a specific section (does not show the "show all {n} actions")

Wiregram Dropdown Menu

Props

I propose that this behavior be built-in to Polaris and made available without a prop.

Best practices

The searchable listbox for actions should:

  • Enable merchants with large numbers of extensions and built-in actions to find what they're looking for
  • Not get in the way of merchants with few extensions or built-in actions

Context

This proposal is part of the Action Extensions project. As we provide Partners new ways to add extensions, we anticipate the need for searching and organizing the actions menus will increase.

References

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions