Skip to content

fix(COffcanvas): restore body scroll when unmounted while visible #562

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

Merged
mrholek merged 1 commit into from
Sep 14, 2026
Merged

fix(COffcanvas): restore body scroll when unmounted while visible #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions packages/coreui-react/src/components/offcanvas/COffcanvas.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,17 @@ export const COffcanvas = forwardRef<HTMLDivElement, COffcanvasProps>(
if (_visible && !scroll) {
document.body.style.overflow = 'hidden'
document.body.style.paddingRight = '0px'
return
}

if (!scroll) {
} else if (!scroll) {
document.body.style.removeProperty('overflow')
document.body.style.removeProperty('padding-right')
}

return () => {
if (!scroll) {
document.body.style.removeProperty('overflow')
document.body.style.removeProperty('padding-right')
}
}
}, [_visible])

const handleDismiss = () => {
Expand Down
11 changes: 11 additions & 0 deletions packages/coreui-react/src/components/offcanvas/__tests__/COffcanvas.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,14 @@ test('COffcanvas customize and event on keypress', async () => {

vi.useRealTimers()
})

test('COffcanvas restores body scroll when unmounted while visible', () => {
const { unmount } = render(<COffcanvas visible={true} />)

expect(document.body.style.overflow).toBe('hidden')

unmount()

expect(document.body.style.overflow).toBe('')
expect(document.body.style.paddingRight).toBe('')
})
Loading