Add filtersClass prop to GlDashboardLayout
What does this MR do?
Adds a filtersClass prop to GlDashboardLayout, bound to the <section> that wraps the #filters slot.
Closes #3660 (closed)
Why
Slot content renders inside the filters <section>, so consumers had no way to style the wrapper itself. Some styles only work on the wrapper, e.g. position: sticky for a sticky filter bar. The only workaround was selecting gitlab-ui's [data-testid='filters-container'] from application CSS, which couples app styling to a test hook that can be renamed at any time.
The concrete driver is gitlab-org/gitlab!256156 (merged) (sticky filter bar on explore analytics dashboards), which currently reaches in via that data-testid.
Approach
- New optional
Stringprop, default'', bound with:classalongside the existing static classes. Existing classes anddata-testidare unchanged, so this is non-breaking. - Follows the existing
*Classprop pattern in gitlab-ui:GlDashboardPanel(containerClass,bodyContentClass) in the samedashboards/directory, plusGlCard,GlTabs,GlEmptyStateandGlAccordionItem. - Unit tests cover the custom class being applied and the default classes being kept.
- Changeset added (
minor).
Out of scope
header-container and actions-container have the same gap, as noted in the issue. I left them out to keep this MR small, and they can get the same treatment if someone needs it.
Screenshots or screen recordings
N/A. No visual change by default; the prop is empty unless a consumer sets it.
Integrations
No migration required (additive, non-breaking). Once released, gitlab-org/gitlab can replace the [data-testid='filters-container'] selector from !256156 with filters-class. I'll open that follow-up after the release.
-
GitLab: mr_url
-
CustomersDot: mr_url
-
Duo UI: mr_url
-
Status Page: mr_url
-
Docs: mr_url
-
Switchboard: 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
- The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”.
- For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
- Relevant label(s) are applied to the MR.
- The MR is added to a milestone.
- Added the
~"component:*"label(s) if applicable. - A changeset is added when this MR will do a patch, minor, or major update. More information can be found in
doc/changesets.md.
Components
- GitLab UI's contributing guidelines.
- If the MR changes a component's API, integration MR(s) have been opened (see integrations above).
Documentation
- If creating a new component page from scratch, it follows the page template structure.
- Content follows the GitLab Documentation Style Guide when appropriate.
- Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter.
- If embedding a Figma file, it follows the Figma embed guide.
- Review requested from any GitLab designer or directly from a maintainer or trainee maintainer.
- Maintainer review follows the Pajamas UX maintainer review checklist.
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-labelfor 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.
Related to #3660 (closed)