open-indy / koa11y Goto Github PK
View Code? Open in Web Editor NEWEasily check for website accessibility issues
Home Page: https://open-indy.github.io/Koa11y
License: MIT License
Easily check for website accessibility issues
Home Page: https://open-indy.github.io/Koa11y
License: MIT License
I'm on a Mac and my experience has always been in a windows environment and need help getting this application installed on my mac.
sh-3.2# npm install
npm WARN saveError ENOENT: no such file or directory, open '/Users/charlescarter/package.json'
npm WARN enoent ENOENT: no such file or directory, open '/Users/charlescarter/package.json'
npm WARN charlescarter No description
npm WARN charlescarter No repository field.
npm WARN charlescarter No README data
npm WARN charlescarter No license field.
Hello,
I am an user of macOS, but I use mostly Manjaro (derived from Arch Linux) and Porteus (a Slackware-based) when I am out home.
I may have missed this but I couldn't find info regarding the matter. Errors in the report are clear that need fixing. but what what about the warnings and notices? Do they require fixing to be compliant?
[Can't check website for a11y].
"Run" button grayed out and general report in HTML is unavailible.
The image a11y section also not possible to use: The console generates “[]” only instead of the code to paste in Koa11y to enable “Run” button and make image a11y check.
URL used: https://www.oracle.com/index.html
Line 1. “Console was cleared”,
Line 2. [],
Line 3. The above code has been copied to your clipboard
Line 4. Undefined
Can this be the reason? was in the console when pressed F12:
• onMessage extension extension.js: 24
avast! Online Security plugin (c) 2013 Avast Corp.
@author: Lucian Corlaciu
Injected specifics - Google Chrome
• Clean the cache of the scraper (new onComplete event) ial.js:425
{
console.log("Clean the cache of the scraper (new onComplete event)");
AvastWRC.ial.sp.checkSafeShopDataConst = JSON.parse(JSON.stringify({
data: null,
completed: false,
result: [],
rescan: -1,
}));
},
Instead of manually running for each subpath is it possible to run this tool for all subroutes of the domain?
Does this test for accessibility to spell text out loud by pressing tab using JAWS on windows or screen reader on MAC ???
Feature Request :
Also can you add support for multiple URL
Our websites requires a login.
How do I check sites that are only available when someone is logged in?
pa11y({
actions: [
'click element #tab-1',
'wait for element #tab-1-content to be visible',
'set field #fullname to John Doe',
'check field #terms-and-conditions',
'uncheck field #subscribe-to-marketing',
'wait for fragment to be #page-2',
'wait for path to not be /login',
'wait for url to be https://example.com/'
]
});
We could add in a UI for this feature. We should draw some mockups of how this could be implemented.
Actions support was added into Pa11y in version 4.4.0. Updating to this version may break Koa11y, so we'll need to proceed carefully when exploring adding this feature.
Koa11y 3.0.0 ships with Node 5.12.0 built in. So we need to ensure that the version of Pa11y we are using does not require a version of Node newer than that, or we will need to drop support for a lot of legacy OS's.
nw.App.manifest.version
app.externalLink('https://github.com/open-indy/Koa11y/releases');
function.It seems Koa11y is not actively maintained anymore. The last commit was over 2 years ago.
See also #50
Is Koa11y still under active development? Just wondering if I should use Pa11y if so.
Though Ctrl+X/Ctrl+C/Ctrl+V works fine in Windows and Linux, the Cmd+C/Cmd+X/Cmd+V need to be added manually for OSX.
This is a simple thing that should be included in the next release.
There is a Travis CI config but it seems to be unused. Is it obsolete or just not enabled for this repo?
Koa11y could be ran on itself to find a11y issues.
Open the index.htm
file in your browser, copy the URL and paste it in.
Upload the report here. Then we can work on fixing issues.
Win 10 x64
Everything is in one big app.js
file and it was thrown together hastily.
Parts could be split up into other files, and better written.
Much of this refactoring should occur while writing unit tests, as it will ensure all changes/reorganization are done safely and cleanly. It also ensures that we won't need to refactor again to make sure all functions are written in a testable way.
Error during the first start of application, “debug” txt-file auto-created: **_
[1024/202034:ERROR:image_metadata_extractor.cc(114)] Couldn't load libexif. 126
_**
Full description: Error log created automatically during the first start of the application - After the download and extraction of zip-files directly into root folder (C:) or into a deeply nested subfolder (C:\Users\xxx\Downloads\xxx\WIN_Koa11y_3.0.0\Koa11y). Error log txt-file “debug” will be created in the folder of application files.
Expected result: Successful first start of application
Actual result: Error log: “debug”-txt file during the first start of application
Steps to reproduce:
Reproducability: always on OS Windows 10, x64
Severity: critical (potentially disabls key functionality)
debug.log
@TheJaredWilcurt @jamesboyer92 @robgaston1 @mardisworld
Koa11y 2.0.0 is using Pa11y 4.1.1 where as the latest version is 4.7.0. Other dependencies may need updating too.
There are a lot of possible new features that could be added to Koa11y that would require us to update and change it's, currently, very simple interface.
New designs for Koa11y should retain all existing functionality:
New designs should take into consideration possible new features:
Question:
Does this program consider text-shadow to be a part of the font colour? I've reworked my main colour to be above and beyond the 7.0 ratio, and it's still failing saying the same 3.46 or 1.11, or whatever it is ratio no matter how I change the colour. nothing quite like running Koally and seeing 300+ errors over colour ratio.
Thanks!
The guideline code shown at the top of this error message has a predictable pattern. We could grab the G17
part of it and use that to create a link to give the reader of the report more details about the guideline.
Here is a quick sketch of a possible implementation.
var guideline = 'WCAG2AAA.Principle1.Guideline1_4.1_4_6.G17.Fail';
var criteria = guideline.split('.')[4];
var url = 'https://www.w3.org/TR/WCAG20-TECHS/' + criteria + '.html';
var link = '<a href="' + url + '">' + guideline + '</a>';
The above code needs more thorough testing.
The spec pages include a lot more information, and links to resources on that topic. but could be too technical for most users. If we can find a plain English alternative that would be preferred.
Koa11y should also support basic auth for testing websites behind .htpasswd.
Similar to using pa11y itself, Koa11y phantom process dies when running a report. I don't see any logs or detail of the error but I'm assuming its the same that occurs with pa11y:
Error: HeadlessError: Phantom Process died
at ClientRequest. (/usr/lib/node_modules/pa11y/node_modules/node-
phantom-simple/node-phantom-simple.js:659:12)
at emitOne (events.js:96:13)
at ClientRequest.emit (events.js:188:7)
at Socket.socketErrorListener (_http_client.js:310:9)
at emitOne (events.js:96:13)
at Socket.emit (events.js:188:7)
at emitErrorNT (net.js:1277:8)
at _combinedTickCallback (internal/process/next_tick.js:80:11)
at process._tickCallback (internal/process/next_tick.js:104:9)
What can I do, when instead of loading Imgs and their respective Alts that enables manually check for Alts’ description informativeness (image a11y section in the Koa11y v3.0.0), there are only placeholders instead? Screanshot attached.
As workaround, I loaded the website before and refreshed it prior to the concole code pasting, scrolled down through the whole page and clicked through all the carussels, but images / except the logo with its description / did not load for a11y check.
The URL used: https://www.business-punk.com
System: Win10, x64
Koa11y v3.0.0
We could add some unit testing to the code, so that when updating it in the future we are less likely to break things.
NVDA is a free/open source screen reader that can be used for testing.
Log any issues found to GitHub Issues page to be resolved.
Run Koa11y against a URL - get HTML file with results, no errors
Run Koa11y via code paste - get different results with errors
Ran Pa11y via command line & get different results
I just installed Koa11y on Ubuntu 18.04 by following the video instructions, and Koa11y did not run out of the box. I tried running Koa11y from the cli, and got a no such file or directory error for libgconf-2.so.4
It was fixed with apt install libgconf-2-4
, and Koa11y is working. I am passing this along in case it helps someone or can be bundled in a future version.
It would be useful to parse a sitemap of a domain to test all subpages / onsite links.
there are some sections that can still be converted to be handled by Vue, and we can split up stuff to Vue components.
aXe is similar to Pa11y. It may be nice to have a setting built in to use Pa11y or aXe as the test runner.
Is there a way to use Koa11y for pages that need a user to be logged in?
Setup the ability to switch languages and let people contribute translations.
see: scout-app.io
Requested by @rahulr892 in #19.
Will need to come up with a design for how to allow for this feature in a simple to understand way.
Please help me how to install Koa11y on Linux there is no file .configure OR any documentation for installing on Linux("ubuntu").
Koa11y is a pretty decent tool, but it's pointless if no one knows it exists.
We could improve the template used on HTML reports to include some branding, and useful information, like what version of Koa11y was used to create that report. Maybe some information about the date/time the report was generated.
A dashboard that rolls up all reports into one overview would help provide tracking and a synopsis over time. See the-a11y-machine for an example.
Hey @TheJaredWilcurt, not sure if you've been keeping up with the latest Pa11y udates, but we're hopefully releasing Pa11y 5.0 soon (beta announcement). As this is a breaking change I wondered whether you'd need any help integrating with Koa11y, or if there's anything generic we can add to the core library to make your job easier?
Hello,
do you have plans to update Koa11y to WCAG 2.1?
Thanks a lot for this program :)
Tanja
I care a lot about accessibility and would love to have some "real humans" to check my websites additionally to automated tools like Koa11y.
Where can I find them?
Maybe Koa11y can help to bring website builders and disabled users together?
Thanks!
Dear all,
I'm on Fedora 26 behind a corporate proxy.
I get the following error with Koa11y v3.0.0 at startup when running it on http://google.com
In the console:
app.js:718
Error: Error opening url "http://google.com" : Host google.com not found
at Object.<anonymous> (/(...)/Koa11y-3.0.0/node_modules/truffler/lib/truffler.js:154:18)
at /(...)/Koa11y-3.0.0/node_modules/node-phantom-simple/node-phantom-simple.js:60:18
at IncomingMessage.<anonymous> (/(...)/Koa11y-3.0.0/node_modules/node-phantom-simple/node-phantom-simple.js:645:9)
at IncomingMessage.emit (events.js:165:20)
at endReadableNT (_stream_readable.js:1101:12)
at process._tickCallback (internal/process/next_tick.js:152:19)
However, Pa11y in command-line ( ./node_modules/pa11y/bin/pa11y http://google.com
) runs fine.
I assume that I need to pass proxy settings to pa11y, how could I do that?
In koa11y-settings.json
file?
Thanks for your help!
Likely under the File > Export
menu. This would export out your project's settings.json
file to your desktop, so it can be shared with someone else. During the import process, the only machine-specific setting would be the output directory for where to store reports. So we'd need to do an fs.exists
on the computer that is importing the settings, and if the output folder does not exist, then it will default to the user's desktop.
Maybe we need a UI for this, a modal that gives the user import/export tabs. Import settings would include what the default output folder should be, and if you want to add these projects (show a list of them), to your current projects, or replace your current projects with them? or maybe just always add, and if they want to remove stuff they can remove pages/projects manually? Need UX discussions.
Export modal could have a list of all projects, so you can check/uncheck what you want to export/share.
There are a few parts of Koa11y that aren't fully accessible via the keyboard alone. This should be resolved in the next version.
It would be awesome if there were a way to audit pages behind a login.
Perhaps, it could be possible to simply drop in a cookie that is used for the audit, or there could be some script for going to the login page first.
Create a build script that will automatically generate the package on each OS.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.