refactor(TextInput): deprecate inputRef prop#3446
Open
mvanhorn wants to merge 1 commit intotrussworks:mainfrom
Open
refactor(TextInput): deprecate inputRef prop#3446mvanhorn wants to merge 1 commit intotrussworks:mainfrom
mvanhorn wants to merge 1 commit intotrussworks:mainfrom
Conversation
Add @deprecated JSDoc tag and runtime console.warn when inputRef is used. Users should migrate to the ref prop (via forwardRef) which was added in trussworks#3011. Part of trussworks#3016 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Deprecates the
inputRefprop on TextInput. Adds a@deprecatedJSDoc annotation and a runtimeconsole.warnwheninputRefis passed. Users should use therefprop instead, which was added in #3011.Why this matters
inputRefis now redundant sinceforwardRefsupport was added. This deprecation gives users a migration path before removal in a future major version.Changes
src/components/forms/TextInput/TextInput.tsx: Added@deprecatedJSDoc tag toinputRefprop definition and auseEffectthat logs a deprecation warning wheninputRefis used.Testing
This is a deprecation notice only - no behavioral changes. The existing tests should pass unchanged since
inputRefstill works.Part of #3016
This contribution was developed with AI assistance (Claude Code).