Skip to content

docs(cndocs): sync Pressable ripple docs#1027

Merged
sunnylqm merged 1 commit into
productionfrom
auto-translate-20260523-pressable
May 23, 2026
Merged

docs(cndocs): sync Pressable ripple docs#1027
sunnylqm merged 1 commit into
productionfrom
auto-translate-20260523-pressable

Conversation

@sunnylqm
Copy link
Copy Markdown

@sunnylqm sunnylqm commented May 23, 2026

Summary

  • Synced cndocs/pressable.md with the upstream Pressable documentation update for android_ripple.
  • Added the missing explanation that RippleConfig.color accepts both plain colors and PlatformColor, including automatic updates when system configuration changes.
  • Ran the sync script and verified the other candidates (checkbox, clipboard, colors, removed-component stubs, modal) were already aligned / stale timestamp candidates.

website → cnwebsite config/deps

  • Upstream merge only changed docs/pressable.md and yarn.lock for this batch.
  • website/package.json and cnwebsite/package.json dependency/devDependency versions are already aligned; no cnwebsite config changes were needed.

Test Plan

  • yarn --cwd cnwebsite build
    • Build succeeds; it still emits existing non-fatal Docusaurus SSG/HTML-minifier warnings for versioned docs paths.

Summary by CodeRabbit

  • Documentation
    • Enhanced android_ripple attribute documentation to clarify PlatformColor support and explain automatic color updates during system theme transitions.
    • Improved formatting and alignment of RippleConfig properties documentation for better readability.

Review Change Stack

@netlify
Copy link
Copy Markdown

netlify Bot commented May 23, 2026

Deploy Preview for reactnativecn failed. Why did it fail? →

Name Link
🔨 Latest commit 9c27979
🔍 Latest deploy log https://app.netlify.com/projects/reactnativecn/deploys/6a113ddaf86ae40008664c25

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 23, 2026

📝 Walkthrough

Walkthrough

This PR updates the Pressable component documentation to clarify that android_ripple color accepts PlatformColor values and automatically updates when system configuration changes, and adjusts the RippleConfig properties table formatting for better readability.

Changes

Pressable Documentation

Layer / File(s) Summary
Ripple configuration documentation
cndocs/pressable.md
android_ripple property description enhanced with PlatformColor support details and automatic color update behavior. RippleConfig properties table (color, borderless, radius) adjusted for alignment and line wrapping without content changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A ripple documentation spring,
Where colors dance with system's wing,
Platform themes now clearly shown,
Tables neat and well-aligned throne,
Chinese docs bloom, crisp and bright! 🌸

🚥 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 The title 'docs(cndocs): sync Pressable ripple docs' clearly and concisely summarizes the main change: synchronizing Pressable ripple documentation in the Chinese docs.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch auto-translate-20260523-pressable

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f74701ce-3ef7-41a0-8221-2e4a72778b14

📥 Commits

Reviewing files that changed from the base of the PR and between a822ad1 and 9c27979.

📒 Files selected for processing (1)
  • cndocs/pressable.md

Comment thread cndocs/pressable.md
Comment on lines +263 to +267
| Name | Type | Required | Description |
| ---------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| color | [color](colors) | No | 定义波纹的颜色。 |
| borderless | boolean | No | 定义波纹效果是否包含边框。 |
| radius | number | No | 定义波纹的半径。 |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
| 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.

@sunnylqm sunnylqm merged commit bc321fe into production May 23, 2026
1 of 5 checks passed
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