/
[Proposal] Bring search bar back to the Learner Dashboard

[Proposal] Bring search bar back to the Learner Dashboard

Overview

During testing for the Quince, Redwood and Sumac releases, testers pointed out the the search bar allowing learners to search among their courses on the Learner Dashboard was removed (potentially as part of the MFE conversion process). Here is a link to the initial test failure report: [Test failure] TC_LEARNER_50: Missing search box in the learner dashboard ยท Issue #431 ยท openedx/wg-build-test-release. After doing some digging, I was unable to trace back a product-informed decision that led to the removal of this search bar.

Problem

The problem is that if a learner is enrolled in a number of courses, they are not able to search among the courses theyโ€™ve enrolled in to quickly find the course they are looking for. Although learners are able to filter the learner dashboard, they are not able to search the courses theyโ€™ve enrolled in by keyword, which may in many cases be the quickest way to isolate the course theyโ€™re looking for among their courses on the learner dashboard.

Here is an image of our current learner dashboard:

Current state.png

Here is a screenshot of the learner dashboard from a member of our community. He notes this was taken on either Quince or Palm:

ย 

Use cases

As a learner, I need to be able to search for a course among My Courses (or the courses Iโ€™m currently enrolled in) listed on the Learner Dashboard by keyword, so that I can easily find the course Iโ€™m looking for rather than having to scroll through the full list or play around with the available filters.

For the initial release of this search bar, I propose allowing users to enter a search term, and have it search through and return matches to the course name, organization, course number, and course run fields.

In the future, we may want to expand the fields through to include course-level tags and/or course content for courses the learner is currently enrolled in.

Proposed solution

Reintroduce the search bar to the Learner Dashboard, so that the learner can search their courses by keyword.

Considerations for Basic Implementation Requirements:

A search bar has been added to the Learner Dashboard page (where the red box indicates in the screenshot below)

392130779-16864893-c4fc-4102-88d4-ee296580d956.png

  • The search bar and search bar submit button match the same base styling for search bars and search bar submit buttons elsewhere in the LMS

  • The search bar is prefilled with the text: Search your courses

  • The search bar submit button is labeled: Search

  • When a user types a character into the search bar, the prefilled text clears

  • The user can submit a search by clicking the submit button or clicking enter

  • When a search term is submitted, the search bar searches through and returns results if the keyword matches or is contained in the course name, organization, course number, and/or course run fields.

    • When there are search results returned:

      • The search results return only courses that match the keyword search

      • The user sees the number of courses that match my search

      • The user sees the search term they entered

      • The user can clear their search by:

        • Clicking the x button next to the search term

        • Deleting the text in the search bar and clicking enter

    • When there are no search results returned:

      • The user sees a message that reads: We couldn't find any results for "<search term>".

Considerations for Basic Implementation Requirements

By the time of launch, the following requirements are met:

  • Unit tests written

  • Docs updated

  • a11y requirements

  • I18n / l10n requirements

  • Deprecation plan if applicable

  • Acceptance Criteria tests