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

Fix Dialog background scroll #3907

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

liamsms
Copy link
Contributor

@liamsms liamsms commented Jul 29, 2024

Closes #3906

Added disableScroll prop to FloatingComponent, which sets the document body overflow to hidden to prevent background scrolling.

Copy link

changeset-bot bot commented Jul 29, 2024

🦋 Changeset detected

Latest commit: 7d5d6f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@salt-ds/core Minor
@salt-ds/countries Patch
@salt-ds/data-grid Patch
@salt-ds/lab Patch

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

Copy link

vercel bot commented Jul 29, 2024

@liamsms is attempting to deploy a commit to the FED Team Team on Vercel.

A member of the Team first needs to authorize it.

@liamsms liamsms marked this pull request as ready for review July 30, 2024 11:02
@Fercas123
Copy link
Contributor

this change should probably be built as a prop in FloatingComponent rather than in dialog, since it could be reused in other implementations like drawer

@liamsms
Copy link
Contributor Author

liamsms commented Nov 10, 2024

this change should probably be built as a prop in FloatingComponent rather than in dialog, since it could be reused in other implementations like drawer

Hi - I've updated this to be a prop disableScroll?: boolean in FloatingComponent.

Fercas123
Fercas123 previously approved these changes Nov 12, 2024
tayyabataimur
tayyabataimur previously approved these changes Jan 22, 2025
Copy link

vercel bot commented Jan 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
saltdesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 10, 2025 11:40am

Copy link
Contributor

@joshwooding joshwooding left a comment

Choose a reason for hiding this comment

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

Will follow up with feedback

/**
* Disables scrolling the document body while the floating component is open.
*/
disableScroll?: boolean;
Copy link
Contributor

Choose a reason for hiding this comment

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

We should check if we're happy with the naming here

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the choices are: lockScroll, preventScroll or disableScroll

Copy link
Contributor

@tayyabataimur tayyabataimur Feb 12, 2025

Choose a reason for hiding this comment

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

lockScroll is consistent with Floating UI's terminology but will it be intuitive for our users, and be consistent in naming with other components in Salt?

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

Successfully merging this pull request may close these issues.

Disable background scroll when Dialog open
5 participants