Skip to content

docs(input): sync documented API with current props#301

Merged
RtlZeroMemory merged 1 commit intomainfrom
docs/input-api-contract
Mar 19, 2026
Merged

docs(input): sync documented API with current props#301
RtlZeroMemory merged 1 commit intomainfrom
docs/input-api-contract

Conversation

@RtlZeroMemory
Copy link
Copy Markdown
Owner

@RtlZeroMemory RtlZeroMemory commented Mar 18, 2026

Summary

Updated the input widget docs and catalog to match the current controlled API, and added a narrow integration test that pins readOnly plus focusable: false behavior.

Problem

The input docs and catalog had drifted from the shipped API. They omitted readOnly and focusable, 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 readOnly and focusable props, 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 build
node --test packages/core/dist/app/__tests__/widgetRenderer.integration.test.js
npm run lint
npm run typecheck

Notes

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

    • Expanded input widget configuration with new properties: readOnly (prevents editing), focusable (controls keyboard navigation), and additional styling options.
    • Input widget API now uses object-based parameters for improved flexibility and readability.
  • Documentation

    • Updated input widget documentation with new property descriptions and behavior guidelines.

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 020b4dd2-0fff-40c0-bae8-535bf1ba7178

📥 Commits

Reviewing files that changed from the base of the PR and between 27c61b6 and eb1cc86.

📒 Files selected for processing (3)
  • docs/widgets/catalog.json
  • docs/widgets/input.md
  • packages/core/src/app/__tests__/widgetRenderer.integration.test.ts

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Input Widget Documentation
docs/widgets/catalog.json, docs/widgets/input.md
Expanded input widget's commonProps to include readOnly, focusable, disabled, onBlur, dsSize, and focusConfig. Updated example usage from positional API to object-based configuration pattern. Documented new readOnly and focusable boolean props with focus behavior details.
Integration Test
packages/core/src/app/__tests__/widgetRenderer.integration.test.ts
Added test case verifying that a readOnly input with focusable: false is excluded from tab-order traversal and focus moves to the next focusable element.

Possibly related PRs

Poem

🐰 A rabbit hops through focus flows,
ReadOnly shields, focusable shows,
Tab and bound with grace so true,
Input widgets, shiny new!

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(input): sync documented API with current props' directly and accurately summarizes the main change: aligning input widget documentation and catalog with the current implementation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/input-api-contract
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

@RtlZeroMemory RtlZeroMemory merged commit eccac07 into main Mar 19, 2026
32 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