chore(DesignTokens): Improve performance of TokensTable story
What does this MR do?
chore(DesignTokens): Improve performance of TokensTable story
The TokensTable story was rendering all tokens at once, which is over 1,000 rows. This had quite poor performance, and made interacting with the table unpleasant. This was worsened by the lack of debounce on the search field.
This commit improves performance by:
- debouncing on the search field, so re-renders aren't triggered on every key press;
- paginating tokens, so they're not all rendered at once.
It also improves the searching behaviour by using fuse.js to do fuzzy searching, rather than the basic filtering provided by GlTable:
- searches are fuzzy, so exact substring matches are no longer required;
- results are sorted by closeness to the query (see https://www.fusejs.io/concepts/scoring-theory.html);
- only the name, value, description and deprecated fields are now searched, previously all were (see https://bootstrap-vue.org/docs/components/table#filtering);
- the standard GlSearchBoxByType component is used for the search input, providing a search icon and clear button.
Finally, this switches to a fixed table layout, which is generally faster for the browser to render, and makes sure the value column text wraps if needed.
Screenshots or screen recordings
Before | After |
---|---|
simplescreenrecorder-2025-01-22_17.07.32 | simplescreenrecorder-2025-01-23_14.03.37 |
Integration merge requests
-
GitLab: mr_url -
CustomersDot: mr_url -
Status Page: mr_url
Does this MR meet the acceptance criteria?
This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.
Toggle the acceptance checklist
Conformity
-
Code review guidelines. -
GitLab UI's contributing guidelines. -
If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer. -
If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer. -
If the MR changes a component's API, integration MR(s) have been opened (see integration merge requests above). -
Added the ~"component:*"
label(s) if applicable.
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
Security reports checked/validated by a reviewer from the AppSec team
Accessibility
If this MR adds or modifies a component, take a few moments to review the following:
-
All actions and functionality can be done with a keyboard. -
Links, buttons, and controls have a visible focus state. -
All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label
for icons that have meaning or perform actions. -
Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false"
toaria-expanded="true"
when an accordion is expanded. -
Color combinations have sufficient contrast.