User interface

Standardized patterns developers can follow to create a consistent and user-friendly experience

Introduction

This section provides a curated set of user interface patterns to help developers build consistent, intuitive, and accessible user experiences.

Each pattern addresses a common scenario — such as navigation, selection, input, and feedback — with instructions and implementation examples.

Combo boxes and search modals

When you implement a user interface feature that allows a user to find an item in a collection, if you need to select data from the API, then use the Search endpoint for the collection.

A search query is specifically designed for this purpose.

• It selects the minimum number of columns required from the database to find matching criteria.

• It returns the minimum number of properties required for typical search results.

• Therefore, it is optimized for server-side performance and download speed.

For example, if you are building a combo box in React to find and select a gradebook, then use the Search endpoint in the API:

progress/gradebooks/search

For details, refer to the Developer Documentation.