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

Add custom DataTableSkeleton component to support display of filters #3533

Merged
merged 1 commit into from
Aug 6, 2024

Conversation

AlanGreene
Copy link
Member

@AlanGreene AlanGreene commented Aug 2, 2024

Changes

If a consumer of the Table component provides a value for the filters prop, they should reasonably be able to expect that those filters will be displayed regardless of the loading state of the rest of the table.

Update the loading state to use a custom DataTableSkeleton component based on the Carbon DataTableSkeleton, but with some minor changes:

  • only display the description skeleton if the table uses a description
  • remove support for zebra striping as this is not used in the Dashboard
  • include support for different row sizes directly in the skeleton component instead of relying on consumers to provide custom classnames to control this
  • if the table has filters, render them in the table skeleton toolbar
    • ensure the filters are left-aligned, replacing the toolbar button skeleton which is present by default and right-aligned

/kind misc

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (new features, significant UI changes, API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added kind/misc Categorizes issue or PR as a miscellaneuous one. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 2, 2024
@AlanGreene AlanGreene requested review from briangleeson and removed request for skaegi August 2, 2024 15:50
If a consumer of the Table component provides a value for the `filters`
prop, they should reasonably be able to expect that those filters will
be displayed regardless of the loading state of the rest of the table.

Update the loading state to use a custom DataTableSkeleton component
based on the Carbon DataTableSkeleton, but with some minor changes:
- only display the description skeleton if the table uses a description
- remove support for zebra striping as this is not used in the Dashboard
- include support for different row sizes directly in the skeleton component
  instead of relying on consumers to provide custom classnames to control this
- if the table has `filters`, render them in the table skeleton toolbar
  - ensure the filters are left-aligned, replacing the toolbar button
    skeleton which is present by default and right-aligned
Copy link
Contributor

@briangleeson briangleeson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 6, 2024
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: briangleeson

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 6, 2024
@tekton-robot tekton-robot merged commit 755db6d into tektoncd:main Aug 6, 2024
7 of 8 checks passed
@AlanGreene AlanGreene deleted the table_loading_filters branch August 6, 2024 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants