[LG-5473] feat(drawer): add hasPadding prop to decouple padding from scrollable behavior #3078
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 9c68bbf The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new hasPadding prop to the Drawer component, decoupling padding control from scroll behavior. Previously, developers could only remove padding by disabling scrolling, but now these two concerns can be controlled independently.
Key changes:
- Added
hasPaddingprop (defaults totrue) that controls content padding independently fromscrollable - Updated
scrollableprop to only control scroll behavior, not padding - Enhanced Storybook stories with play tests for visual regression testing
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
packages/drawer/src/utils/getLgIds.ts |
Added scrollContainer ID for test targeting |
packages/drawer/src/DrawerToolbarLayout/DrawerToolbarLayout/DrawerToolbarLayoutContent.tsx |
Integrated hasPadding prop into toolbar layout content |
packages/drawer/src/DrawerToolbarLayout/DrawerToolbarLayout/DrawerToolbarLayout.types.ts |
Added hasPadding type definitions and updated documentation |
packages/drawer/src/Drawer/Drawer.types.ts |
Added hasPadding prop to main Drawer interface |
packages/drawer/src/Drawer/Drawer.tsx |
Implemented hasPadding logic and updated container rendering |
packages/drawer/src/Drawer/Drawer.styles.ts |
Refactored styles to separate padding and scroll concerns |
packages/drawer/src/Drawer/Drawer.spec.tsx |
Removed obsolete scrollable-specific tests |
packages/drawer/src/Drawer.stories.tsx |
Enhanced stories with play tests and better coverage of prop combinations |
packages/drawer/README.md |
Updated documentation with behavior matrix and clearer explanations |
.changeset/wise-queens-take.md |
Added changeset documenting the new feature |
| @@ -198,6 +198,26 @@ export const getDrawerStyles = ({ | |||
| drawerClassName, | |||
| ); | |||
|
|
|||
| export const getResizerStyles = ({ | |||
There was a problem hiding this comment.
[nitpick] The getResizerStyles function has been moved to an unexpected location in the middle of the file. Consider keeping function definitions grouped logically - this function was previously defined after getScrollContainerStyles and should remain near other layout-related style functions for better code organization.
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
I prefer ordering these in order of usage 🤷
stephl3
commented
Aug 27, 2025
| @@ -67,44 +67,6 @@ describe('packages/drawer', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| describe('scrollable prop', () => { | |||
There was a problem hiding this comment.
nothing to see here folks... just removing some AI-generated tests that were definitely doing something 🤡
Comment on lines
-407
to
-423
| const fullWidthHeightContentStyles = css` | ||
| width: 100%; | ||
| height: 100%; | ||
| background: linear-gradient( | ||
| 135deg, | ||
| ${palette.green.light1}, | ||
| ${palette.green.dark1} | ||
| ); | ||
| display: flex; | ||
| align-items: center; | ||
| justify-content: center; | ||
| `; | ||
| const FullWidthHeightContent = () => ( | ||
| <div className={fullWidthHeightContentStyles}> | ||
| <Subtitle>Full Width/Height Content</Subtitle> | ||
| </div> | ||
| ); |
There was a problem hiding this comment.
Decided it was better to consistently render LongContent as children in these stories and use play tests to show the scroll behavior
|
Size Change: +224 B (+0.01%) Total Size: 2.01 MB
ℹ️ View Unchanged
|
tsck
reviewed
Aug 27, 2025
2 reasons for this:
|
tsck
reviewed
Aug 27, 2025
There was a problem hiding this comment.
No concerns technically. Curious why we went with a prop that controls styling here instead of exposing a class name constant that consumers can use to style things themselves? I just know I've seen us doing the latter a bit in the recent past.
2 reasons for this:
- we already have
scrollableand preserving that parallel pattern can be less mental overhead for consumers- we're opinionated about styling the
Drawerand don't want to give too much flexibility here. Consumers should either have the standard padding or use the full-width/height
I feel like when we want to lock down style, a more common approach I've seen lately is to use variants. Such as the default vs compact Menu, where primarily one has less padding. Does this component not lend itself to that well?
I'm just concerned that we're starting to make it so that some components export child classes, while others have style props, without very clear justification as to why. This seems like more mental overhead for consumers in general when using LG. This is something we should codify more in our future architecture/philosophy doc.
I'm not a hard blocker, just want to make sure we're looking at all options since I feel its a bit of a different pattern than I've seen lately.
|
@stephl3 and I spoke offline. We agree that a class name opens things up a bit much. Though it is done elsewhere and could be useful, it might not be the best general approach. A variant is probably a good option, but in cases like this where there are already |
tsck
approved these changes
Aug 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✍️ Proposed changes
This PR adds a new
hasPaddingprop to theDrawercomponent to allow independent control of padding and scrollable behavior. Previously, padding could only be removed by settingscrollabletofalse, which tightly coupled these two concerns. Now developers can control padding and scroll behavior independently, providing more flexibility for full-width/height content scenarios.The changes include:
hasPaddingprop (defaults totrue) that controls content padding independentlyscrollableprop to only control scroll behaviorhasPaddinginDrawerToolbarLayoutcomponents🎟️ Jira ticket: LG-5473
✅ Checklist
pnpm changesetand documented my changes🧪 How to test changes
Test independent padding control:
hasPadding={true/false}andscrollable={true/false}Test visual regression with play tests:
Test DrawerToolbarLayout integration:
hasPaddingprop is properly exposed in toolbar data objectsscrollableusage