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

DescriptionList feature enhancements #1517

Merged
merged 12 commits into from
Feb 24, 2025
Merged

DescriptionList feature enhancements #1517

merged 12 commits into from
Feb 24, 2025

Conversation

haideralsh
Copy link
Contributor

@haideralsh haideralsh commented Feb 18, 2025

Description

Introduces a new and improved DescriptionList component with enhanced layout capabilities:

  • Grid-based layouts with column/row spanning
  • Responsive layouts using container queries
  • Multiple layout modes (stacked, inline, auto)
  • Configurable columns and group sizing

Breaking Changes

  • Requires wrapping term/detail pairs with DescriptionGroup
  • Renamed border radius value from pill to rounded

Changes include

  • breaking change: a change that is not backwards-compatible and/or changes current functionality
  • fix: a non-breaking change that solves an issue
  • feature: a non-breaking change that adds functionality
  • chore: contains no changes affecting the library, such as documentation or test updates

Feature checklist

  • Appropriate tests have been added
  • Documentation has been updated
  • Accessibility has been considered

@haideralsh haideralsh changed the title Dl improvements DescriptionList feature enhancements Feb 24, 2025
@haideralsh haideralsh force-pushed the dl-improvements branch 2 times, most recently from 30517a2 to 719e8c7 Compare February 24, 2025 18:54
BREAKING CHANGE: Introduces a DescriptionGroup that allows the
DescriptionList to be displayed in advanced layouts. Each pair of
DescriptionTerm and DescriptionDetail needs to be wrapped with a
DescriptionGroup following this release.

Introduces `columns` and `groupMinWidth` props on the DescriptionList.
The `overlay` prop in the Sidebar component has been enhanced to accept
both boolean and string values, allowing for more flexible overlay
behavior without breaking existing implementations.

- The `overlay` prop now accepts:
  - `true`: Render a visible overlay.
  - `false`: Render an invisible overlay.
  - `"transparent"`: Render an invisible overlay (same as "false").
  - `"show"`: Render a visible overlay (same as "true").
  - `"hide"`: Do not render the overlay at all (new behavior).

- **No changes are required** for existing implementations using boolean
 values (`true` or `false`). These will continue to function as before.
- To completely remove the overlay, use `overlay="hide"`.
- For new components, consider using the string values for more explicit
 control over overlay behavior.

This change is backward-compatible, ensuring that existing codebases
remain functional. However, adopting the new string values is
recommended for future-proofing and clarity in new components.
BREAKING CHANGE: changes the name to align with the intention behind the
theme value.
@haideralsh haideralsh merged commit 99cb55c into master Feb 24, 2025
4 checks passed
@haideralsh haideralsh deleted the dl-improvements branch February 24, 2025 22:06
Copy link

🎉 This PR is included in version 14.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant