docs(input): sync documented API with current props#301
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe input widget's documentation and test coverage are enhanced to showcase new focus-control properties (readOnly and focusable). The widget example transitions from positional to object-based API syntax, and integration testing validates tab-order behavior for read-only inputs. Changes
Possibly related PRs
Poem
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
Summary
Updated the input widget docs and catalog to match the current controlled API, and added a narrow integration test that pins
readOnlyplusfocusable: falsebehavior.Problem
The input docs and catalog had drifted from the shipped API. They omitted
readOnlyandfocusable, described focus behavior too loosely, and showed an outdated factory example signature.Root cause
The input contract evolved in code and integration tests, but the widget docs and catalog entry were not kept in sync with those changes.
Fix
Documented the current
readOnlyandfocusableprops, clarified controlled-input persistence and focus semantics, corrected the catalog example, and added an integration test covering a read-only input opting out of Tab order.Tests
npm run buildnode --test packages/core/dist/app/__tests__/widgetRenderer.integration.test.jsnpm run lintnpm run typecheckNotes
No broad input behavior changes were made. This PR hardens the documented contract and adds one focused regression test for existing runtime behavior.
Summary by CodeRabbit
New Features
readOnly(prevents editing),focusable(controls keyboard navigation), and additional styling options.Documentation