Skip to content

Commit c5a8c64

Browse files
committed
docs: add CHANGELOG.md and update contribution guidelines
1 parent a508e94 commit c5a8c64

4 files changed

Lines changed: 260 additions & 1 deletion

File tree

β€Ž.github/PULL_REQUEST_TEMPLATE.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@
2323
- [ ] I tested on Android
2424
- [ ] I tested on Web
2525
- [ ] I updated the documentation (if needed)
26+
- [ ] I added a changelog entry (if needed)

β€ŽAGENTS.mdβ€Ž

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,16 @@ When creating a PR, use the template from `.github/PULL_REQUEST_TEMPLATE.md`:
9191
2. **Type of Change** - Select one: Bug fix, New feature, Breaking change, or Documentation update
9292
3. **Test Plan** - Explain how the changes were tested
9393
4. **Screenshots / Videos** - Include if applicable
94-
5. **Checklist** - Mark platforms tested (iOS, Android, Web) and documentation updates
94+
5. **Checklist** - Mark platforms tested (iOS, Android, Web), documentation and changelog updates
95+
96+
#### Changelog
97+
98+
Add entry to `Unpublished` section in `CHANGELOG.md` for user-facing changes:
99+
100+
- `πŸŽ‰ New features` - New functionality
101+
- `πŸ› Bug fixes` - Bug fixes
102+
- `πŸ’‘ Others` - Refactors, internal changes
103+
104+
Format: `- **Platform**: Description. ([#123](https://github.com/lodev09/react-native-true-sheet/pull/123))`
105+
106+
When creating release notes, move entries from `Unpublished` to a new version section.

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 245 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
# Changelog
2+
3+
## Unpublished
4+
5+
### πŸŽ‰ New features
6+
7+
- Added `dismissAll` static method. ([#393](https://github.com/lodev09/react-native-true-sheet/pull/393))
8+
9+
### πŸ› Bug fixes
10+
11+
- **Android**: Fixed keyboard and focus handling inside RN Modal. ([#387](https://github.com/lodev09/react-native-true-sheet/pull/387))
12+
13+
## 3.7.0
14+
15+
### πŸ› Bug fixes
16+
17+
- **Android**: Fixed keyboard dismiss when presenting at dimmed detent.
18+
- Improved keyboard handling for sheet presentation. ([#379](https://github.com/lodev09/react-native-true-sheet/pull/379))
19+
- **Android**: Fixed `pointerEvents` not being respected in TrueSheetFooterView.
20+
- **Android**: Added `pointerEvents` prop support to view managers.
21+
- **Android**: Added RootNodeKind trait for nested sheet touch handling. ([#375](https://github.com/lodev09/react-native-true-sheet/pull/375))
22+
- **Android**: Fixed coordinator layout remeasure on configuration change.
23+
- **Android**: Fixed footer repositioning when keyboard hides via IME action button.
24+
25+
## 3.6.11
26+
27+
### πŸ› Bug fixes
28+
29+
- **Android**: Fixed eventDispatcher propagation via delegate chain for footer touch handling. ([#372](https://github.com/lodev09/react-native-true-sheet/pull/372))
30+
31+
## 3.6.10
32+
33+
### πŸ› Bug fixes
34+
35+
- **Android**: Fixed sheet drag when ScrollView cannot scroll. ([#369](https://github.com/lodev09/react-native-true-sheet/pull/369))
36+
37+
## 3.6.9
38+
39+
### πŸ› Bug fixes
40+
41+
- **Android**: Fixed keyboard handling to only apply for focused views within sheet. ([#365](https://github.com/lodev09/react-native-true-sheet/pull/365))
42+
- **Android**: Fixed sheet dismissing early when container is unmounted.
43+
- **iOS**: Fixed sheets dismissing properly during navigation and reload.
44+
45+
## 3.6.8
46+
47+
### πŸ› Bug fixes
48+
49+
- **iOS**: Fixed keyboard offset preservation when footer resizes. ([#361](https://github.com/lodev09/react-native-true-sheet/pull/361))
50+
- **Android**: Optimized findRootContainerView to return first content view.
51+
- **Android**: Fixed TrueSheet rendering above React Native Modal. ([#359](https://github.com/lodev09/react-native-true-sheet/pull/359))
52+
53+
## 3.6.7
54+
55+
### πŸ› Bug fixes
56+
57+
- Fixed initial present flag reset during recycle.
58+
59+
## 3.6.6
60+
61+
### πŸ› Bug fixes
62+
63+
- **Android**: Fixed setupModalObserver to present lifecycle.
64+
65+
### πŸ’‘ Others
66+
67+
- Simplified initial presentation to only trigger on attach to window.
68+
69+
## 3.6.5
70+
71+
### πŸ› Bug fixes
72+
73+
- **Android**: Fixed animated sheet dismiss with keyboard shown.
74+
75+
## 3.6.4
76+
77+
### πŸ› Bug fixes
78+
79+
- **Android**: Fixed initial presentation to wait for window attachment.
80+
81+
## 3.6.3
82+
83+
### πŸ› Bug fixes
84+
85+
- **iOS**: Added compile-time check for iOS 26.1+ APIs.
86+
- **Android**: Added safe value for halfExpandedRatio.
87+
88+
## 3.6.2
89+
90+
### πŸ› Bug fixes
91+
92+
- **iOS**: Fixed blur intensity with backgroundBlur on iOS 26.1+.
93+
94+
## 3.6.1
95+
96+
### πŸ› Bug fixes
97+
98+
- **iOS**: Fixed fallback to view.backgroundColor when UIDesignRequiresCompatibility is true.
99+
100+
## 3.6.0
101+
102+
### πŸŽ‰ New features
103+
104+
- Added `elevation` prop for Android and Web. ([#355](https://github.com/lodev09/react-native-true-sheet/pull/355))
105+
106+
### πŸ› Bug fixes
107+
108+
- **Android**: Fixed keyboard dismiss issue with backdrop. ([#351](https://github.com/lodev09/react-native-true-sheet/pull/351))
109+
- **iOS**: Fixed native backgroundEffect for blur on iOS 26.1+. ([#350](https://github.com/lodev09/react-native-true-sheet/pull/350))
110+
111+
## 3.5.8
112+
113+
### πŸŽ‰ New features
114+
115+
- Added `headerStyle` and `footerStyle` props.
116+
117+
## 3.5.7
118+
119+
### πŸ› Bug fixes
120+
121+
- **Web**: Fixed pointerEvents on footer container.
122+
123+
## 3.5.6
124+
125+
### πŸŽ‰ New features
126+
127+
- **Web**: Added 'none' option to `stackBehavior` prop.
128+
- **Web**: Added shadow for web sheet.
129+
130+
## 3.5.5
131+
132+
### πŸ› Bug fixes
133+
134+
- Fixed pointerEvents on header, footer and host view.
135+
136+
## 3.5.4
137+
138+
### πŸ› Bug fixes
139+
140+
- **iOS**: Fixed initial presentation to defer until view is in window hierarchy.
141+
142+
## 3.5.3
143+
144+
### πŸ› Bug fixes
145+
146+
- **iOS**: Fixed TrueSheetView being included in scroll view pinning traversal.
147+
148+
## 3.5.2
149+
150+
### πŸ› Bug fixes
151+
152+
- **Android**: Fixed sheet showing briefly when navigating within a stack.
153+
154+
## 3.5.1
155+
156+
### πŸ› Bug fixes
157+
158+
- **Android**: Fixed parent stacking after rn-screen dismissed.
159+
- **Android**: Fixed dragging on parent sheet when child is stacked.
160+
- **Android**: Improved dim tap handling for stacked sheets.
161+
- **Android**: Fixed collapse to lowest detent on back press when non-dismissible.
162+
- **Android**: Fixed sheet fade before hiding when rn-screen modal shows.
163+
- **Android**: Fixed content clipping to rounded corners on older API levels.
164+
- **Android**: Fixed collapse to lowest detent on dim tap when non-dismissible.
165+
- **Android**: Fixed bottom sheet centering horizontally on rotation.
166+
- **Android**: Fixed sheet from reshowing when returning from background with rn-screens.
167+
- **Android**: Fixed dismiss animation on back button press.
168+
- **Android**: Fixed footer positioning using onSlide for API < 30.
169+
- **Android**: Fixed grabber hitbox causing touch issues.
170+
- **Android**: Fixed sheet position during non-animated present.
171+
- **Android**: Fixed stacked sheet translation on dismiss.
172+
- **Android**: Fixed translation on initialDetentIndex present.
173+
- **Android**: Fixed initial present on older android versions.
174+
- **Android**: Fixed halfExpandedRatio to be between 0 and 1.
175+
176+
### πŸ’‘ Others
177+
178+
- **Android**: Replaced DialogFragment with CoordinatorLayout. ([#344](https://github.com/lodev09/react-native-true-sheet/pull/344))
179+
- **Android**: Refactored to use BottomSheetDialogFragment. ([#342](https://github.com/lodev09/react-native-true-sheet/pull/342))
180+
181+
## 3.5.0
182+
183+
### πŸŽ‰ New features
184+
185+
- **Android**: Improved transition animations and refactored detent calculations. ([#337](https://github.com/lodev09/react-native-true-sheet/pull/337))
186+
187+
### πŸ› Bug fixes
188+
189+
- **Android**: Fixed sheet stack restoration when modal dismisses.
190+
- **Android**: Fixed dim view alpha animation when restoring from modal.
191+
- **Android**: Improved keyboard handling and detent restoration.
192+
- **Android**: Fixed target keyboard height for detent calculations.
193+
- **Android**: Fixed window visibility to prevent keyboard non-focus issue.
194+
195+
## 3.4.2
196+
197+
### πŸ› Bug fixes
198+
199+
- **Android**: Fixed sheet from showing when app returns from background.
200+
201+
## 3.4.1
202+
203+
### πŸŽ‰ New features
204+
205+
- **iOS**: Added default blur tint for iOS < 26. ([#334](https://github.com/lodev09/react-native-true-sheet/pull/334))
206+
207+
## 3.4.0
208+
209+
### πŸŽ‰ New features
210+
211+
- **Android**: Added custom dim view with smooth interpolation. ([#327](https://github.com/lodev09/react-native-true-sheet/pull/327))
212+
- **Android**: Added parent translation updates when child sheet size changes.
213+
214+
### πŸ› Bug fixes
215+
216+
- **Android**: Fixed flashing footer during initial present.
217+
- **Android**: Fixed dim view hiding when RN Screen is presented.
218+
219+
### πŸ’‘ Others
220+
221+
- Refactored mocks to export per module. ([#329](https://github.com/lodev09/react-native-true-sheet/pull/329))
222+
223+
## 3.3.5
224+
225+
### πŸ› Bug fixes
226+
227+
- **Android**: Fixed grabber shadow by using bringToFront instead of elevation.
228+
229+
## 3.3.4
230+
231+
### πŸŽ‰ New features
232+
233+
- Added adaptive grabber color for light/dark mode. ([#325](https://github.com/lodev09/react-native-true-sheet/pull/325))
234+
235+
## 3.3.3
236+
237+
### πŸ› Bug fixes
238+
239+
- Fixed key window fallback for cold start and deep link handling. ([#323](https://github.com/lodev09/react-native-true-sheet/pull/323))
240+
241+
## 3.3.2
242+
243+
### πŸ› Bug fixes
244+
245+
- Fixed batch dismiss behavior for stacked sheets. ([#322](https://github.com/lodev09/react-native-true-sheet/pull/322))

β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,4 @@ When you're sending a pull request:
148148
- Review the documentation to make sure it looks good.
149149
- Follow the pull request template when opening a pull request.
150150
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
151+
- Add a changelog entry to the `Unpublished` section in [CHANGELOG.md](./CHANGELOG.md) for any user-facing changes.

0 commit comments

Comments
Β (0)