Skip to content

docs: Fix broken tables and stale prop documentation - #612

Merged
MatiPl01 merged 1 commit into
mainfrom
docs/fix-props-drift
Aug 24, 2026
Merged

docs: Fix broken tables and stale prop documentation#612
MatiPl01 merged 1 commit into
mainfrom
docs/fix-props-drift

Conversation

@MatiPl01

Copy link
Copy Markdown
Owner

Audits the documentation against the library source and closes the drift that had accumulated.

Corrects prop names and values that no longer match the API: Sortable.Handle's mode is 'fixed-order' rather than 'fixed' (the docs contradicted their own live examples), itemPositionsAnimationMode is itemsLayoutTransitionMode, and autoScrollSpeed was removed in #454 but was still documented and shown as a copy-pasteable snippet.

Documents 13 props that were missing entirely, most of them auto scroll settings that were never added after the #454 rewrite, plus the grid horizontal-layout props (rows, rowHeight), the auto-adjust-offset props, and Touchable's onDoubleTap.

Fixes wrong types and defaults: the auto scroll props were marked Animatable although they are not, item layout animations are nullable, and several defaults disagreed with the source.

Also removes an orphaned table fragment that was left behind when #536 inserted the stackingOrder section inside the overflow table, which rendered as raw markdown on the page.

Verified with a full Docusaurus build, which passes with no warnings and, because the site sets onBrokenLinks: 'throw', also confirms every link still resolves.

@vercel

vercel Bot commented Aug 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
react-native-sortables-docs Ready Ready Preview Aug 24, 2026 9:32am

@MatiPl01 MatiPl01 self-assigned this Aug 24, 2026
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 24, 2026
@MatiPl01
MatiPl01 merged commit 8777de3 into main Aug 24, 2026
11 checks passed
@MatiPl01
MatiPl01 deleted the docs/fix-props-drift branch August 24, 2026 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant