Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Pagination, PaginationNav] update Usage docs #4013

Closed
Tracked by #2085
laurenmrice opened this issue Apr 10, 2024 · 1 comment · Fixed by #4175
Closed
Tracked by #2085

[Pagination, PaginationNav] update Usage docs #4013

laurenmrice opened this issue Apr 10, 2024 · 1 comment · Fixed by #4175

Comments

@laurenmrice
Copy link
Member

laurenmrice commented Apr 10, 2024

Ref original issue: #3238
Ref boxnote: Usage tab PDF a11y comments


Acceptance criteria

  • Update the pagination component Usage tab documentation with the new content template.
  • Add pagination nav as another variant.
  • Look at Michael Gowers A11y PDF review and resolve any open questions and suggestions.

Things to address in the current docs

Most of the A11y considerations were that we have not updated out docs with the new content template. Below are some other comments:

Overview

  • Are there exceptions of not displaying pagination if there are more than 25 pages/items of content? (I have removed this guidance because I feel that pagination can be used for different reasons and there is some more nuance than suggesting 25 pages/item is the rule)
  • What are the different contexts of where pagination is used?

Best practices

  • The labeling of the pagination sections could be improved a11y wise. This will need to be updated in code first before changing them here in the docs. I have made a separate issue for this in the mono repo which we need to further refine and tackle [Pagination]: improve order of select labeling for screen readers carbon#16538

  • Add a section for "Responsiveness" and how the pagination content should change and respond depending on the breakpoint. Only pertinent information should remain in the pagination component at smaller breakpoints.

@thyhmdo
Copy link
Member

thyhmdo commented Jun 4, 2024

Roll over the next sprint. The effort seems right, the main goal for rollover is to review.

@sstrubberg sstrubberg modified the milestones: 2024 Q2, 2024 Q3 Jul 1, 2024
@kodiakhq kodiakhq bot closed this as completed in #4175 Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants