Background
Evaluate adding a pagination component in Codex.
Description
Controls for navigating through pages or lists.
User stories
- As a user, I need to navigate through large sets of data or results distributed across different pages.
History
Describe or link to prior discussions related to this component
Known use cases
| Pagination within Table T360154. | |
| Pagination in Search results page | |
| Pagination for lists for the the Invitation list feature by the Campaigns team | |
Existing implementations
These artifacts are listed for historical context. The figma spec, linked below, is the source of truth for the new component.
Wikimedia community:
- OOUI: add the relevant OOUI widget name(s) here, if applicable. See OOUI demos.
- Vue: add any existing Vue implementations, if applicable. See Projects using Vue.js.
External libraries:
- Add links to any examples from external libraries
Codex implementation
Component task owners
- Designer: add the main designer's name
- Developer: add the main developer's name
Open questions
- List any current open questions here
Design spec
| ๐ Figma specifications |
Anatomy
The pagination will contain the following customizable elements:
- Select: to choose the number of items to show per page. The default number will be 10, and then it will be customizable to 20, 50, and 100 items.
- Text indicator: to show the items being displayed (e.g. Showing results 1โ10 of 999,999)
- Buttons: to navigate the pages. There will be buttons to navigate from Previous/Next pages and from First/Last pages.
These elements could be shown/hidden according to each pagination's case:
Guidelines
Designer should provide the guidelines and associated images for this component. Once the guidelines have been documented, please remove this note and share a link to the guidelines below.
| Doc with the guidelines |
Demos
Designer should describe how the component should be documented in the demos, including configurable and standalone demos.
Acceptance criteria
Minimum viable product
This task covers the minimum viable product (MVP) version of this component. MVP includes basic layout, default states, and most important functionality.
MVP scope
- List all parts of the MVP scope for this component
Design
- Design the Figma exploration file and include its link in this task:
- Document the component's guidelines and provide the link to the doc and its images in this task.
- Publish the main component in the Figma library. This step will be done by a DST member.
Code
- Implement the component in Codex
- Implement the guidelines in the component's page
Future work
- If applicable, list future work that should be done for this component after the MVP is implemented as part of this task. You should open new, standalone tasks for all future work.







