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.

Sign up for GitHub

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

Jump to bottom

docs(drawer): fix expanded uncontrolled error with controls #7181

Merged
merged 3 commits into from
Jan 31, 2025
Merged

docs(drawer): fix expanded uncontrolled error with controls #7181

merged 3 commits into from
Jan 31, 2025

Conversation

nuria1110
Copy link
Contributor

Proposed behaviour

  • Prevent uncontrolled error in Drawer when using expanded prop in controls.
  • Fix broken links in storybook docs.
  • Remove mention of roundedCornerOptOut flag in Box prop descriptions.

Current behaviour

  • In Drawer storybook examples, setting expanded prop in controls causes uncontrolled error.
  • Some links in storybook docs are broken.
  • RoundedCornerOptOut mentioned in Box prop description.

Checklist

  • Commits follow our style guide
  • Related issues linked in commit messages if required
  • Screenshots are included in the PR if useful
  • All themes are supported if required
  • Unit tests added or updated if required
  • Playwright automation tests added or updated if required
  • Storybook added or updated if required
  • Translations added or updated (including creating or amending translation keys table in storybook) if required
  • Typescript d.ts file added or updated if required
  • Related docs have been updated if required

QA

  • Tested in provided StackBlitz sandbox/Storybook
  • Add new Playwright test coverage if required
  • Carbon implementation matches Design System/designs
  • UI Tests GitHub check reviewed if required

Additional context

Testing instructions

@nuria1110 nuria1110 self-assigned this Jan 27, 2025
tomdavies73
tomdavies73 previously approved these changes Jan 29, 2025
View reviewed changes
src/components/box/box.component.tsx
@@ -61,7 +61,7 @@ export interface BoxProps
rowGap?: Gap;
/** Design Token for Box Shadow. Note: please check that the box shadow design token you are using is compatible with the Box component. */
boxShadow?: BoxShadowsType;
/** Design Token for Border Radius. Note: please check that the border radius design token you are using is compatible with the Box component. **This prop will not do anything if you have the roundedCornerOptOut flag set in the CarbonProvider** */
Copy link
Contributor

Choose a reason for hiding this comment

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

praise: good spot, we need to find who missed this the first time :/ (it was me)

@Parsium Parsium self-requested a review January 29, 2025 13:50
Parsium
Parsium previously approved these changes Jan 29, 2025
View reviewed changes
@Parsium Parsium marked this pull request as ready for review January 29, 2025 13:56
@Parsium Parsium requested a review from a team as a code owner January 29, 2025 13:56
@nuria1110 nuria1110 dismissed stale reviews from Parsium and tomdavies73 via 7ecc1b2 January 30, 2025 14:35
@nuria1110 nuria1110 merged commit 433f4a6 into master Jan 31, 2025
28 checks passed
@nuria1110 nuria1110 deleted the FE-6884 branch January 31, 2025 13:37
@carbonci
Copy link
Collaborator

🎉 This PR is included in version 147.0.1 🎉

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
Reviewers

@paulrobinson88 paulrobinson88 paulrobinson88 approved these changes

@tomdavies73 tomdavies73 tomdavies73 approved these changes

@Parsium Parsium Parsium approved these changes

Assignees

@nuria1110 nuria1110

Labels
No UX QA Required Passed QA Passed Review released Squad Front End
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@nuria1110 @carbonci @Parsium @tomdavies73 @paulrobinson88