-
Notifications
You must be signed in to change notification settings - Fork 83
feat: subcomponents log console warnings when used outside their parents (FE-7167) #7305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Parsium
wants to merge
16
commits into
master
Choose a base branch
from
context-error-handling
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
…lMenu or VerticalMenuFullscreen
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.
Proposed behaviour
For subcomponents that rely on their parent Carbon components to function, ensure a console warning is logged when they are not nested within their required parent.
This includes subcomponents of the following components:
Breadcrumbs
ButtonToggleGroup
Card
Dl
(Definition list)FlatTable
StepFlow
StepSequence
Tile
VerticalMenu
Current behaviour
Many subcomponents must be nested within their parent components in order to function correctly. No error handling occurs if this isn't the case. This means developers using these components incorrectly won't receive any warning that they're following an anti-pattern.
Checklist
d.ts
file added or updated if requiredQA
Additional context
Why log errors over throwing them?
For now,
createStrictContext
logs an error to the browser console and returns a fallback default value, as we are aware this anti-pattern has been used in practice, and we want to avoid breaking apps at this stage. This behaviour should be replaced with throwing an error in the future.Why don't
Accordion
,Tabs
, etc. log errors?Currently these components use the legacy
React.Children
API to modify the props of its children. This will be changed in the future in favour of context. When this occurs, similar error handling will need to be done.Testing instructions