Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: add component name to overlay #5

Merged
merged 1 commit into from
May 1, 2020
Merged

feat: add component name to overlay #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions example/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ import * as React from 'react';
import * as ReactDOM from 'react-dom';
import AxeMode from '../src/index';

function Subtitle() {
return <h6>Accessibility testing componentized</h6>;
}

function Image() {
return (
<img
src="https://avatars1.githubusercontent.com/u/23662329?v=4"
width="40"
height="40"
id="hey"
/>
);
}

const App = () => {
return (
<AxeMode>
Expand All @@ -16,17 +31,12 @@ const App = () => {
/>
</svg>
</a>
<img
src="https://avatars1.githubusercontent.com/u/23662329?v=4"
width="40"
height="40"
id="hey"
/>
<Image />
</header>
<main>
<div className="login">
<h1>Axe Mode</h1>
<h6>Accessibility testing componentized</h6>
<Subtitle />
<input placeholder="Username" />
<input placeholder="Password" />
<button aria-expanded="foo" onClick={() => console.log('yo')}>
Expand Down
6 changes: 3 additions & 3 deletions src/icons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const IconMinor: React.FC<Omit<
<title id={titleId}>Minor impact</title>
<path
d="M439.8,30.73C330.44,13.58,233.42,80.12,124.31,73.18l.13-1.74a31.5,31.5,0,0,0-62.83-4.65L34.12,438.28A31.49,31.49,0,0,0,63.21,472c.79.06,1.57.09,2.36.09A31.51,31.51,0,0,0,97,442.93l6.85-92.58c109,16.51,205.76-49.64,314.59-42.6a31.22,31.22,0,0,0,33.21-29.06q7.15-107.8,14.3-215.09A31.13,31.13,0,0,0,439.8,30.73Z"
fill="#e8a217"
fill="#FF9800"
/>
</svg>
);
Expand All @@ -39,7 +39,7 @@ export const IconModerate: React.FC<Omit<
<title id={titleId}>Moderate impact</title>
<path
d="M250,18C121.87,18,18,121.87,18,250S121.87,482,250,482,482,378.13,482,250,378.13,18,250,18Zm-20.6,89.34h42a14.54,14.54,0,0,1,14.52,15.35l-8.33,148.79A14.54,14.54,0,0,1,263,285.21H237.4a14.53,14.53,0,0,1-14.52-13.76l-8-148.79A14.54,14.54,0,0,1,229.4,107.34Zm49.35,287.19q-10.26,10.13-28.87,10.13-19.08,0-29-10.25T211,366q0-18.39,9.78-28.52t29.1-10.13q19.32,0,29.22,10T289,366Q289,384.4,278.75,394.53Z"
fill="#ce0000"
fill="#FF5B5B"
/>
</svg>
);
Expand All @@ -61,7 +61,7 @@ export const IconSevere: React.FC<Omit<
<title id={titleId}>Severe impact</title>
<path
d="M492.39,420,282.09,44.09C268.05,19,232,19,217.91,44.09L7.61,420c-13.71,24.51,4,54.72,32.09,54.72H460.3C488.38,474.73,506.1,444.52,492.39,420Zm-263-291.94h42a14.54,14.54,0,0,1,14.52,15.35l-8.33,148.79A14.54,14.54,0,0,1,263,305.94H237.4a14.54,14.54,0,0,1-14.52-13.76l-8-148.79A14.53,14.53,0,0,1,229.4,128.07Zm49.35,287.19q-10.26,10.13-28.87,10.13-19.08,0-29-10.25t-9.9-28.4q0-18.37,9.78-28.51t29.1-10.13q19.32,0,29.22,10t9.9,28.63Q289,405.13,278.75,415.26Z"
fill="#d16d00"
fill="#FFB963"
/>
</svg>
);
Expand Down
18 changes: 17 additions & 1 deletion src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,20 @@ function validateNode(node: ElementContext): Promise<Result[]> {
});
}

// Copied from:
// https://stackoverflow.com/questions/29321742/react-getting-a-component-from-a-dom-element-for-debugging
// ¯\_(ツ)_/¯
function getComponentFromNode(node: HTMLElement): string {
const [component] = Object.keys(node)
.filter(key => key.startsWith('__reactInternalInstance$'))
.map((key: string) => {
const fiberNode = (node as any)[key];
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't figure the types out here so I just told TS to shut up, for now.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't be afraid to tell TS to shut it's annoying whining from time to time!

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How else would you expect it to learn some manners 😄

const component = fiberNode && fiberNode._debugOwner;
return component.type.displayName || component.type.name;
});
return component;
}

function segmentViolationsByNode(violations: Result[]): ViolationsByNode {
// Find all DOM nodes affected by the violations
const nodes = violations.flatMap(violation =>
Expand Down Expand Up @@ -125,7 +139,9 @@ function Violation({
</svg>
</button>
</div>
<code>{target}</code>
<code>
{getComponentFromNode(document.querySelector(target)) || target}
</code>
{violations.map(violation => {
const [{ any, all }] = violation.nodes.filter(node =>
node.target.includes(target)
Expand Down
7 changes: 1 addition & 6 deletions src/styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,8 @@ axe-mode-overlay {
z-index: 1337;
animation: slideDown 0.4s ease-in-out;
}

.popover h1,
.popover p {
.popover h2 {
margin: 0;
}

.popover h1 {
font-size: 20px;
color: #222328;
}
Expand Down