Skip to content

feat(drawer): deprecate noBodyStyles and preventScrollRestoration#1649

Open
te6-in wants to merge 1 commit into
devfrom
feat/drawer-deprecate-body-lock-props
Open

feat(drawer): deprecate noBodyStyles and preventScrollRestoration#1649
te6-in wants to merge 1 commit into
devfrom
feat/drawer-deprecate-body-lock-props

Conversation

@te6-in

@te6-in te6-in commented Jun 9, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • 문서
    • Drawer/BottomSheetnoBodyStylespreventScrollRestoration 옵션을 deprecated 처리(제거 예정 버전: 1.3).
    • 1.2.x에서는 기존 동작 유지, 1.3부터는 해당 옵션들이 무시되어 각기 기본 동작처럼 동작합니다(noBodyStyles=true, preventScrollRestoration=false).
    • 마이그레이션 가이드 및 deprecated 표에 관련 설명을 추가했습니다.

@changeset-bot

changeset-bot Bot commented Jun 9, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 08a64cd

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

This PR includes changesets to release 2 packages
Name Type
@seed-design/react-drawer Patch
@seed-design/react 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

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d1953101-d7e4-4866-b26d-f57b93a8fefb

📥 Commits

Reviewing files that changed from the base of the PR and between 6822197 and 08a64cd.

📒 Files selected for processing (3)
  • .changeset/deprecate-drawer-body-lock-props.md
  • docs/content/docs/migration/deprecations.mdx
  • packages/react-headless/drawer/src/useDrawer.ts
✅ Files skipped from review due to trivial changes (2)
  • .changeset/deprecate-drawer-body-lock-props.md
  • packages/react-headless/drawer/src/useDrawer.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/content/docs/migration/deprecations.mdx

📝 Walkthrough

Walkthrough

Drawer의 noBodyStyles, preventScrollRestoration, onAnimationEnd 옵션을 SEED React 1.3에서 제거 예정으로 표시하고 Changeset, 마이그레이션 문서, JSDoc에 관련 안내를 추가합니다.

Changes

Drawer props deprecation

Layer / File(s) Summary
Type documentation에 deprecation 주석 추가
packages/react-headless/drawer/src/useDrawer.ts
UseDrawerPropsnoBodyStylesonAnimationEnd JSDoc에 SEED React 1.3 제거 예정 안내 및 1.3부터 해당 옵션들이 각각 기본값처럼 동작한다는 설명을 추가했습니다.
마이그레이션 가이드에 deprecated 항목 등록
docs/content/docs/migration/deprecations.mdx
Deprecated 현황 표에 Drawer - noBodyStylesDrawer - preventScrollRestoration 항목(삭제 예정 버전 1.3.0, 대체안 없음, 비고: 1.3부터 무시되어 기본값처럼 동작)을 추가했습니다.
Changeset 메타데이터 작성
.changeset/deprecate-drawer-body-lock-props.md
@seed-design/react-drawer 패키지에 대한 patch Changeset을 추가해 두 옵션의 deprecated 및 1.3 전환 시 동작 변경을 기록했습니다.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 작은 주석 하나 남기네,
버전은 흐르고 깃발은 바뀌네,
Drawer는 조용히 길을 비켜주고,
코드 읽는 너는 미리 알아두네,
당근 한 입 축하 인사! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR 제목은 변경 사항의 핵심을 명확하게 설명합니다. noBodyStylespreventScrollRestoration 옵션의 deprecation 처리가 주요 변경 사항이며, 제목이 이를 정확히 반영합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/drawer-deprecate-body-lock-props

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Alpha Preview (Stackflow SPA)

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Alpha Preview (Storybook)

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Alpha Preview (Docs)

@te6-in te6-in force-pushed the feat/drawer-deprecate-body-lock-props branch from 56504d9 to 6822197 Compare June 9, 2026 05:57
Mark the vaul-derived noBodyStyles/preventScrollRestoration options on
UseDrawerProps as @deprecated ahead of their removal in SEED React 1.3.

On the current 1.2.x line these options still work: they feed
usePositionFixed, so noBodyStyles={false} applies vaul's body
position:fixed scroll lock and preventScrollRestoration controls scroll
restoration on close. In 1.3 usePositionFixed is removed and the modal
scroll lock moves entirely to usePreventScroll; both options are then
ignored and behave as if pinned to their defaults (noBodyStyles=true,
preventScrollRestoration=false). Upgrading to 1.3 changes behavior only
for code that explicitly set noBodyStyles={false}.

Mirrors the AppBar divider deprecation (1.2.x -> 1.3.0).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@te6-in te6-in force-pushed the feat/drawer-deprecate-body-lock-props branch from 6822197 to 08a64cd Compare June 9, 2026 05:59
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.

1 participant