[NTH - FE] Keep subsection competency pills inside their cards at narrow widths

Aperta Adatta ai principianti
#942 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
react, scss, typescript

Direzione di ricerca

Inizia da src/taxonomy/competency-management/course-search/CourseOutlineSubtree.tsx e CourseSearchBrowse.scss, dove l’issue indica gli stili delle righe e dei badge delle sottosezioni. Controlla le regole esistenti per i titoli di corsi e sezioni, poi visualizza la struttura a 375px e con la colonna del corso su desktop ristretta. Il lavoro è completato quando i badge restano all’interno delle loro schede, gli ID lunghi vengono troncati con etichette complete per gli screen reader e gli ID brevi restano accanto al nome della sottosezione quando c’è spazio.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

User Story

As a course author working in a narrow window, I want each subsection's competency pill to stay inside its card, in order to read the subsection name and use the associate button without anything spilling off the edge.

Description

In the Courses & Content panel, each graded subsection card shows its competency pill to the right of the subsection name. At phone width (375px), or when the course column is dragged narrow on desktop, the pill sticks out past the card and the name runs into it. The pill should drop below the name when the two don't fit side by side, and a competency ID that's still too long should be shortened with an ellipsis.

Context

UX Design

No Figma frame for the narrow case yet. The Acceptance Criteria describe the layout.

  • Screenshot of the current overflow at 375px:
image

Acceptance Criteria

Scenario: Pills stay inside their cards at phone width
  Given Competency Management at a 375px wide viewport
  And a selected competency with a long external ID, such as "Oral Communication"
  When I expand a course and a section that has graded subsections
  Then every subsection's pill sits inside its card
  And the page does not scroll sideways

Scenario: A wide card keeps the pill beside the name
  Given a desktop-width viewport and a selected competency with a short external ID, such as "CCRS-1.3"
  When I expand a course and a section that has graded subsections
  Then each subsection's pill sits on the same line as its name, aligned to the right of the card

Scenario: A narrow card moves the pill below the name
  Given a subsection card too narrow to fit its name and its pill side by side
  When I view that subsection
  Then the pill sits on its own line below the name
  And the name wraps onto more lines without overlapping the pill

Scenario: An ID too long for the card is shortened inside the pill
  Given a selected competency whose external ID is wider than the subsection card
  When I view a subsection's applied or associate pill
  Then the ID ends in an ellipsis inside the pill
  And the competency icon, and the add icon on an associate pill, stay fully visible

Scenario: Screen readers still get the full ID
  Given a subsection pill whose ID is shortened with an ellipsis
  When a screen reader reads the associate button or the applied pill
  Then it announces the full external ID

Scenario: A narrow course column at desktop width
  Given a desktop-width viewport
  And the divider between the competency tree and the course column dragged as far right as it goes
  When I expand a course and a section that has graded subsections
  Then every subsection's pill sits inside its card
Technical Details

This is a suggested approach, not the source of truth. The User Story, Description, and Acceptance Criteria define what must be true when the work is done.

Approach

SubsectionRow in CourseOutlineSubtree.tsx renders the card as one non-wrapping flex row (d-flex align-items-center justify-content-between) of an unstyled name <span> and the pill. The pill has flex-shrink: 0 and no max-width, the ID isn't truncated, and the name keeps the flex default min-width: auto, so neither can give way.

  1. On &__subsection, add flex-wrap: wrap and a gap (spacer 1 vertical, spacer 2 horizontal), so the pill can drop to a second line with space around it.
  2. Give the name span a new &__subsection-title class with flex: 1 1 10rem; min-width: 0; overflow-wrap: anywhere. The 10rem basis decides the wrap: the pill stays beside the name while the name gets at least 10rem, and drops below it otherwise.
  3. On &__subsection-pill, keep flex-shrink: 0 and add min-width: 0; max-width: 100%. Keep the pill's icons and &__subsection-pill-divider at flex-shrink: 0; match the icon selectors to the rendered DOM of CompetencyIcon and Paragon's Icon.
  4. On &__subsection-pill-id, add min-width: 0; overflow: hidden; text-overflow: ellipsis; white-space: nowrap. The associate button's aria-label and the applied pill's sr-only text already carry the full ID, so only the visible text is cut.
  5. The blocked pill from https://github.com/openedx/frontend-app-authoring/pull/3376 shares these classes and needs no separate change.
  6. jsdom doesn't do layout, so check the scenarios in a browser at 375px, at desktop with the divider dragged right, and with a 40-character ID with no spaces.

Files to create and modify

File Change
src/taxonomy/competency-management/course-search/CourseSearchBrowse.scss modified: wrap and gap on the row, new title class, pill and ID truncation
src/taxonomy/competency-management/course-search/CourseOutlineSubtree.tsx modified: title class on the subsection name span

Additional context

  • &__course-title and &__section-title in CourseSearchBrowse.scss already use min-width: 0 and overflow-wrap: anywhere for long titles in the same outline.
  • The "Demonstrate mastery for" heading at the top of the same column (CriteriaAssociationsSection.tsx) already truncates the competency name and its ID badge (.competency-row__badge with text-truncate) with an ellipsis.
Lingua principale
Python
Stelle
10
Fork
35
Merge medio
4g 14h
PR unite (30g)
20

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openedx/openedx-core

Tutte le issue di openedx/openedx-core

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.