docs(cndocs): sync Pressable ripple docs#1027
Conversation
❌ Deploy Preview for reactnativecn failed. Why did it fail? →
|
📝 WalkthroughWalkthroughThis PR updates the Pressable component documentation to clarify that ChangesPressable Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cndocs/pressable.md`:
- Around line 263-267: The table entry for RippleConfig.color is missing
PlatformColor and thus contradicts the earlier note; update the docs so the Type
column for the "color" row references both [color](colors) and PlatformColor
(e.g., "[color](colors) | PlatformColor" or equivalent) to match the support
described at line 125 and ensure consistency for RippleConfig.color.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| | Name | Type | Required | Description | | ||
| | ---------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | ||
| | color | [color](colors) | No | 定义波纹的颜色。 | | ||
| | borderless | boolean | No | 定义波纹效果是否包含边框。 | | ||
| | radius | number | No | 定义波纹的半径。 | |
There was a problem hiding this comment.
RippleConfig.color 类型漏写了 PlatformColor,与上文说明不一致。
Line 265 当前只写了 [color](colors),但 Line 125 已明确支持 PlatformColor。这里建议补齐,避免 API 文档前后矛盾。
Suggested diff
-| color | [color](colors) | No | 定义波纹的颜色。 |
+| color | [color](colors) 或 [PlatformColor](platformcolor) | No | 定义波纹的颜色。 |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Name | Type | Required | Description | | |
| | ---------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | |
| | color | [color](colors) | No | 定义波纹的颜色。 | | |
| | borderless | boolean | No | 定义波纹效果是否包含边框。 | | |
| | radius | number | No | 定义波纹的半径。 | | |
| | Name | Type | Required | Description | | |
| | ---------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | |
| | color | [color](colors) 或 [PlatformColor](platformcolor) | No | 定义波纹的颜色。 | | |
| | borderless | boolean | No | 定义波纹效果是否包含边框。 | | |
| | radius | number | No | 定义波纹的半径。 | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@cndocs/pressable.md` around lines 263 - 267, The table entry for
RippleConfig.color is missing PlatformColor and thus contradicts the earlier
note; update the docs so the Type column for the "color" row references both
[color](colors) and PlatformColor (e.g., "[color](colors) | PlatformColor" or
equivalent) to match the support described at line 125 and ensure consistency
for RippleConfig.color.
Summary
cndocs/pressable.mdwith the upstreamPressabledocumentation update forandroid_ripple.RippleConfig.coloraccepts both plain colors andPlatformColor, including automatic updates when system configuration changes.checkbox,clipboard,colors, removed-component stubs,modal) were already aligned / stale timestamp candidates.website → cnwebsite config/deps
docs/pressable.mdandyarn.lockfor this batch.website/package.jsonandcnwebsite/package.jsondependency/devDependency versions are already aligned; nocnwebsiteconfig changes were needed.Test Plan
yarn --cwd cnwebsite build✅Summary by CodeRabbit
android_rippleattribute documentation to clarifyPlatformColorsupport and explain automatic color updates during system theme transitions.