A11y design enhancements #6563
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,9 @@ | ||
| import React, { FunctionComponent } from 'react'; | ||
| import { styled } from '@storybook/theming'; | ||
| import { Badge, Icons } from '@storybook/components'; | ||
| import { CheckResult } from 'axe-core'; | ||
| import { RuleType } from '../A11YPanel'; | ||
| import { SizeMe } from 'react-sizeme'; | ||
|
There was a problem hiding this comment. We could cut back on the number of dependencies by using https://github.com/storybooks/storybook/blob/next/lib/ui/src/app.js#L4 import ResizeDetector from 'react-resize-detector';There was a problem hiding this comment. That's a good point. I hadn't spotted that in the repo. It looks like it also has the "refreshMode" feature so it fits the needs. Ill convert what I have to use react-resize-detector. Thanks! There was a problem hiding this comment. So I tried the react-resize-detector and there is a delay between when you start an action and the resizing occurs. Think we should switch back to ResizeMe where this did not occur. react-sizeme does an initial, invisible render of the component to measure its size. Then, when the component renders, the size is known and the component can render properly from the beginning. Resize me: There was a problem hiding this comment. I tried switching out the react-resize-detector for resize me but for that use case, react-resize-detector was the better library There was a problem hiding this comment. @ndelangen what do you think about keeping both? |
||
|
|
||
| const impactColors = { | ||
| minor: '#f1c40f', | ||
|
|
@@ -15,18 +16,33 @@ const impactColors = { | |
| const List = styled.div({ | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| paddingBottom: '4px', | ||
| paddingRight: '4px', | ||
| paddingTop: '4px', | ||
| fontWeight: '400', | ||
| } as any); | ||
|
|
||
| const Item = styled.div(({ elementWidth }: { elementWidth: number }) => { | ||
| const maxWidthBeforeBreak = 407; | ||
| return { | ||
| flexDirection: elementWidth > maxWidthBeforeBreak ? 'row' : 'inherit', | ||
| marginBottom: elementWidth > maxWidthBeforeBreak ? '6px' : '12px', | ||
| display: elementWidth > maxWidthBeforeBreak ? 'flex' : 'block', | ||
| }; | ||
| }); | ||
|
|
||
| const StyledBadge = styled(Badge)(({ status }: { status: string }) => ({ | ||
| padding: '2px 8px', | ||
| marginBottom: '3px', | ||
| minWidth: '65px', | ||
| maxWidth: 'fit-content', | ||
| width: '100%', | ||
| textAlign: 'center', | ||
| })); | ||
|
|
||
| const Message = styled.div({ | ||
| paddingLeft: '6px', | ||
| paddingRight: '23px', | ||
| }); | ||
|
|
||
| const Status = styled.div(({ passes, impact }: { passes: boolean; impact: string }) => ({ | ||
|
|
@@ -40,30 +56,63 @@ const Status = styled.div(({ passes, impact }: { passes: boolean; impact: string | |
| }, | ||
| })); | ||
|
|
||
| export enum ImpactValue { | ||
| MINOR = 'minor', | ||
| MODERATE = 'moderate', | ||
| SERIOUS = 'serious', | ||
| CRITICAL = 'critical', | ||
| } | ||
|
|
||
| interface RuleProps { | ||
| rule: CheckResult; | ||
| } | ||
|
|
||
| const formatSeverityText = (severity: string) => { | ||
| return severity | ||
| .charAt(0) | ||
| .toUpperCase() | ||
| .concat(severity.slice(1)); | ||
| }; | ||
|
|
||
| const Rule: FunctionComponent<RuleProps> = ({ rule }) => { | ||
| let badgeType: any = null; | ||
| switch (rule.impact) { | ||
| case ImpactValue.CRITICAL: | ||
| badgeType = 'critical'; | ||
| break; | ||
| case ImpactValue.SERIOUS: | ||
| badgeType = 'negative'; | ||
| break; | ||
| case ImpactValue.MODERATE: | ||
| badgeType = 'warning'; | ||
| break; | ||
| case ImpactValue.MINOR: | ||
| badgeType = 'neutral'; | ||
| break; | ||
| default: | ||
| break; | ||
| } | ||
Armanio marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return ( | ||
| <SizeMe refreshMode="debounce"> | ||
| {({ size }: { size: any }) => ( | ||
| <Item elementWidth={size.width}> | ||
| <StyledBadge status={badgeType}>{formatSeverityText(rule.impact)}</StyledBadge> | ||
| <Message>{rule.message}</Message> | ||
| </Item> | ||
| )} | ||
| </SizeMe> | ||
| ); | ||
| }; | ||
|
|
||
| interface RulesProps { | ||
| rules: CheckResult[]; | ||
| } | ||
|
|
||
| export const Rules: FunctionComponent<RulesProps> = ({ rules }) => { | ||
| return ( | ||
| <List> | ||
| {rules.map((rule, index) => ( | ||
| <Rule rule={rule} key={index} /> | ||
| ))} | ||
| </List> | ||
| ); | ||
|
|
||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this
idused anywhere?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggest:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
after I modified the array of types, its back to being lowercase by default and only the first char is capitalized in the title. Not sure if the id is being used but I can check.
UPDATE: the Id is used in the TooltipLinkList: key={id || (title as string)}