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.

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

feature(extension): HTML Report Card Change, View menu, CSS and fonts, Filter addition, and include Hidden #2056

Merged
merged 37 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
3d68dd8
added icons,changed css and bg color
nam-singh Aug 30, 2024
ebdc304
corrected import and images
nam-singh Sep 4, 2024
b678c89
changes
nam-singh Sep 4, 2024
5b82a22
correction in filter sort
nam-singh Sep 5, 2024
76e402a
seprating images
nam-singh Sep 5, 2024
9ca8a13
changes in utilimages
nam-singh Sep 5, 2024
fa3ef88
correction in expression of elements
nam-singh Sep 5, 2024
8ef1235
commenting hidden filter
nam-singh Sep 5, 2024
023a651
Merge branch 'master' into htmlReport-2019-nam
nam-singh Sep 5, 2024
de9ef8d
Update common/module/src/report/ACReporterHTML.tsx
tombrunet Sep 5, 2024
f16b80d
Rename ACReporterHTML.tsx to ACReporterHTML.ts
tombrunet Sep 5, 2024
cd24253
changes for hidden filter
nam-singh Sep 9, 2024
805a52e
Merge branch 'master' into htmlReport-2019-nam
ErickRenteria Sep 9, 2024
b4d1cee
changes for hidden icon
nam-singh Sep 10, 2024
826f984
correction in total issue
nam-singh Sep 10, 2024
2d45614
change in link text and css
nam-singh Sep 11, 2024
38f2452
css changes
nam-singh Sep 11, 2024
ae7128d
css changes
nam-singh Sep 11, 2024
e0f9216
css change
nam-singh Sep 11, 2024
90da546
Merge pull request #2027 from IBMa/htmlReport-2019-nam
ErickRenteria Sep 12, 2024
c3448a1
css changes
nam-singh Sep 12, 2024
7145590
set initial expand true and change filter order
nam-singh Sep 12, 2024
443b744
css changes
nam-singh Sep 12, 2024
cfcd21c
Merge branch 'master' into htmlReportRelease
tombrunet Sep 12, 2024
3accf0d
Merge branch 'htmlReportRelease' into htmlReport-2026-nam
tombrunet Sep 12, 2024
b20057d
Merge pull request #2034 from IBMa/htmlReport-2026-nam
ErickRenteria Sep 13, 2024
274165d
css changes
nam-singh Sep 13, 2024
033b150
css changes
nam-singh Sep 13, 2024
e376c8d
score css change
nam-singh Sep 17, 2024
e53ff56
font weight of score
nam-singh Sep 17, 2024
99f7906
change in icon order and summary card border
nam-singh Sep 18, 2024
ef87616
color change for summary card
nam-singh Sep 18, 2024
e54b485
bg color of extenstion summ & border in html report
nam-singh Sep 18, 2024
ef801b9
Merge pull request #2049 from IBMa/htmlReport-2035-nam
ErickRenteria Sep 19, 2024
150a6d8
Merge branch 'master' into htmlReportRelease
philljenkins Sep 24, 2024
b9535bd
Update guides and screenshots for new interactive HTML reports
philljenkins Sep 25, 2024
f602cf8
add single quote
philljenkins Sep 26, 2024
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@

&.cds--g10 {
.status-score-tile {
background-color: #BE95FF; // purple / 40
background-color:#E8DAFF ; // purple / 20
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -638,6 +638,8 @@ export class DevtoolsController extends Controller {
let bgController = await getBGController();
let rulesets = await bgController.getRulesets(this.contentTabId);
let tabInfo = await bgController.getTabInfo(this.contentTabId);
let url = tabInfo.url!;
let Ignored = await bgController.getIgnore(url);
if (devtoolsState?.lastReport && rulesets) {
let reportObj: any = {
tabURL: tabInfo.url,
Expand All @@ -649,6 +651,8 @@ export class DevtoolsController extends Controller {
counts: {
"total": devtoolsState?.lastReport.counts.total
},
ignored:Ignored,

results: []
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -206,12 +206,12 @@ export class QuickGuideACApp extends React.Component<{}, quickGuideACAppState> {

<h2 id="scan">2. Create a scan report</h2>
<p>
From a single scan, generate a report in both HTML web and Microsoft Excel XLS spreadsheet formats.
From a single scan, export a report in both HTML web and Microsoft Excel XLS spreadsheet formats.
</p>
<p>
<img
src="assets/img/2_2_ScanReport.png"
alt="open dropdown menu with focus on 'Download current scan'"
alt="'Export XLS' button highlighted"
/>
</p>
<p>
Expand Down
38 changes: 25 additions & 13 deletions accessibility-checker-extension/src/ts/docs/UsingACApp.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -488,25 +488,25 @@ class UsingACApp extends React.Component<{}, UsingACAppState> {

<h2 id="t_single_scan_report">3.4 Create a scan report</h2>
<p>
To generate a report for a single scan in the Checker view:
You can export a report in both HTML web and Microsoft Excel XLS spreadsheet formats while in the Checker view:
</p>
<p>
<img

src="assets/img/2_2_ScanReport.png" //was 3.2Report.png
alt="an open dropdown menu with focus on 'download current scan'."
alt="'Export XLS' button highlighted"
/>
</p>
<p>
Open the 'Reports' dropdown menu and select 'Download current scan'.
Once a page has been scanned, select 'Export XLS'. Both HTML and XLS formats will be downloaded.
</p>
<p>
See <Link inline={true} size="lg" href="#the_report" title="Checker reports">Checker reports</Link> for more details.
</p>

<h2 id="t_multi_scan_report">3.5 Create a multi-scan report</h2>
<p>
To combine up to 50 multiple scans into a single report:
Combine up to 50 multiple scans into a single Microsoft Excel XLS spreadsheet report:
</p>
<p>
<img
Expand All @@ -515,7 +515,7 @@ class UsingACApp extends React.Component<{}, UsingACAppState> {
alt="an open dropdown menu with focus on 'Start storing scans'"
/>
</p>
<p>1. Open the 'Reports' dropdown menu and select 'Start storing scans.'</p>
<p>1. Open the 'Options' dropdown menu and select 'Start storing scans.'</p>
<p>
<img

Expand All @@ -536,7 +536,7 @@ class UsingACApp extends React.Component<{}, UsingACAppState> {
alt="an open dropdown menu with focus on 'download stored scans"
/>
</p> */}
<p>4. Open the 'Reports' dropdown menu and select 'View stored scans'.</p>
<p>4. Open the 'Options' dropdown menu and select 'View stored scans'.</p>
<p>
<img
src="assets/img/3_5_StoredScans.png" //was 3.3Multi4.png
Expand All @@ -554,6 +554,7 @@ class UsingACApp extends React.Component<{}, UsingACAppState> {
<ListItem><strong>Cancel</strong>: to uncheck the selections</ListItem>
<ListItem><strong>Return</strong>: click back (or navigate) into the Checker to continue using the functionality, such as storing more scans</ListItem>
</UnorderedList>
<p>6. Open the 'Options' dropdown menu and select 'Export stored scans'.</p>

<h2 id="focus_view">3.6 Focus view</h2>
<p>
Expand Down Expand Up @@ -1031,24 +1032,35 @@ class UsingACApp extends React.Component<{}, UsingACAppState> {
inline={true} size="lg">Create a multi-scan report</Link>.
</p>

<h3 id="HTML_reports">HTML reports</h3>
<h3 id="HTML_reports">HTML report</h3>
{/* <p><strong>HTML reports</strong></p> */}
<p>
<img
src="assets/img/7_1_ReportHTML.png"
alt="an HTML page for 'IBM accessibility equal access toolkit: accessibility checker report'"
alt="screenshot of a report sorted by Requirements."
/>
</p>
<p>
This interactive report is in an HTML web format that includes:
</p></p>
This interactive report is an accessible web page (single HTML file) that includes:
</p>
<OrderedList>
<ListItem>Scan date and time</ListItem>
<ListItem>URL scanned</ListItem>
<ListItem>Percentage of elements with no detected violations or items to review</ListItem>
<ListItem>Summary of test results </ListItem>
<ListItem>Issue details organized by Requirements or by Rules</ListItem>
<ListItem>Summary of test results by Violations, Needs review, and Recommendations</ListItem>
<ListItem>Issue details organizable by Elements roles, Requirements, or by Rules</ListItem>
<ListItem>‘Learn more’ link with detailed help description for each issue</ListItem>
</OrderedList>
<p>
The interactive features of the report are similar to the Summary report in the Checker view:
</p>
<OrderedList>
<ListItem>Filter the list of issues displayed by selecting either the 'Filter' dropdown or by selecting the checkboxes on the summary tiles by 'Violation', 'Needs review', and 'Recommendation'.</ListItem>
<ListItem>Display the 'Hidden' issues by selecting the 'Filter' dropdown. Note that the counts and total displayed do not include the 'Hidden' issues.</ListItem>
<ListItem>Change the organization of the issues list by selecting the dropdown to see issues by 'Elements roles', 'Requirements', or by 'Rules'. Note that each group is an accordion that can be collapsed for a condensed view.</ListItem>
<ListItem>Display the specific 'What to do' guidance for each individual issue by selecting the 'Learn more' link.</ListItem>
<ListItem>Send the single HTML file to team members or save it in project records.</ListItem>
</OrderedList>
<p>
<strong>Note</strong>: The percentages reported are based on automated tests only.
Be sure to follow all the <Link
Expand All @@ -1066,7 +1078,7 @@ class UsingACApp extends React.Component<{}, UsingACAppState> {
<p>
<img
src="assets/img/7_1_ReportXLS_hidden.png"
alt="an Excel spreadsheet of an accessibility scan report"
alt="an Excel spreadsheet of a scan report"
/>
</p>
<OrderedList>
Expand Down
4 changes: 3 additions & 1 deletion report-react/src/IReport.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export interface IReport {
}
passUniqueElements?: string[]
testedUniqueElements?: number
ignored?:string[]
}

export interface IReportItem {
Expand All @@ -45,7 +46,8 @@ export interface IReportItem {
value: string[],
message: string,
snippet: string,
help: string
help: string,
isHidden?:boolean,
}

export interface ICheckpoint {
Expand Down
34 changes: 33 additions & 1 deletion report-react/src/SavedReport.scss
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
.summReport, .summCard {
margin: 1rem -1rem 0rem -1rem;
padding: 1rem;

border:solid #a8a8a8;
background-color: #FFFFFF;

.title {
Expand All @@ -34,6 +34,9 @@
margin: 1rem 0rem 0rem -1rem;
}
}
.reportTreeGridEmptyText {
margin-top: 5rem;
}

.cds--modal-content {
padding: 1rem 1rem 0rem 1rem;
Expand Down Expand Up @@ -204,4 +207,33 @@
}
}
}
.viewMulti {
float:right;
width: 230px;
.cds--list-box {
max-height: 2rem;
}
.cds--list-box__field {
background-color: #f4f4f4;
border: solid #a8a8a8 1px;
}
}
.iconGroup{
display: flex;
gap: 0.75rem;
align-items: center;
.iconSummary{
display: flex;
align-items: center;
font-weight: 600;
}
}
.reportGroupFilter{
display:flex;
flex-direction:column ;
float: right;
align-items: flex-end;
row-gap: 0.5rem;
}

}
Loading
Loading