feat: Make Component.key public
#2988
Merged
Conversation
This file contains 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
erickzanardo
approved these changes
Jan 21, 2024
luanpotter
reviewed
Jan 21, 2024
| @@ -989,7 +988,7 @@ class Component { | |||
| /// A key that can be used to identify this component in the tree. | |||
| /// | |||
| /// It can be used to retrieve this component from anywhere in the tree. | |||
| final ComponentKey? _key; | |||
| final ComponentKey? key; | |||
There was a problem hiding this comment.
I wonder if we should call it componentKey for the same reason you have exposed; it is possible other people are using key for something else on their components, and this would clash. no strong opinion though
There was a problem hiding this comment.
I think it is rare enough, I've never seen it anywhere else except in the very new flame_riverpod version
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.
Description
Since the user might want to use the
ComponentKeyafter it has been assigned it should be made public.It also updates
Consumer.keytoConsumer.widgetKeyin flame_riverpod to avoid a name clash. (Slightly breaking)Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Migration instructions
If you are using
consumer.keyfrom flame_riverpod you have to now useconsumer.widgetKeyinstead.Related Issues
Closes #2985