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

WCAG 2.0 Support #1320

unknowndomain opened this issue Mar 9, 2019 · 2 comments


Copy link

commented Mar 9, 2019

Describe the feature you'd like
Within the EU, Australia, Canada, Hong Kong, India, Israel, Japan, New Zeland, and the USA any government website, and in many cases publicly funded organisations like Universities or even all businesses are required under law to support WCAG 2.0 or a similar identical law.

Bookstack isn't far off WCAG 2.0 support, and obviously the content people put up must actually bother to make use of accesibility features, but there are a few things which Bookstack fails on, some within automated testing are related to contrast which can easily be fixed using a CSS override in the header.

Describe the benefits this feature would bring to BookStack users
The benefit would be improved accessibility for BookStack users with visual impairments, and that BookStack could be used in the public sector for government and publicly funded websites.

Additional context
One example of a simple change is that the search box at the top of the website doesn't have a label associated, this could be easily added into the markup.

Document language identification is another easy fix.

It doesn't seem that it would be hard to officially support WCAG 2.0 and produce some documentation on how to create content in BookStack that is WCAG compliant.

@ssddanbrown ssddanbrown added this to the v0.27.0 milestone Mar 12, 2019


This comment has been minimized.

Copy link

commented Mar 12, 2019

Thanks for the suggestion @unknowndomain. I agree that supporting accessibility requirements is a good idea for BookStack.

No point actioning anything now due to the design changes, which are changing most of the views, but I have instead assigned this to the next release after the redesign. We'll just aim for baseline support to close this off then any additional or new accessibility concerns can be raised as a new issue.

Something to note though, While I'm happy to aim to achieve accessibility I cannot really support or guarantee full compliance, for such public or government uses, due to the nature of the project being done in free time & non-funded.

ssddanbrown added a commit that referenced this issue Aug 24, 2019
Made a mass of accessibility improvements
- Changed default focus styles
- Updated dropdowns with keyboard navigation
- Updated modals with esc exiting
- Added accessibility attirbutes where needed
- Made many more elements focusable
- Updated hover effects of many items to also apply when focused within

Related to #1320 and #1198
ssddanbrown added a commit that referenced this issue Aug 25, 2019
Made another mass of accessibility improvements
- Set proper semantic tags for main parts of content.
- Removed focus-trap from tag manager/autosuggest.
- Set better accessibility labelling on tag manager.
- Updated collapsible sections to be keyboard navigatable.
- Improved input focus styling to better fit theme.
- Updated custom styled file picker to be accessible via keyboard.

Related to #1320
ssddanbrown added a commit that referenced this issue Aug 25, 2019
Fixed failing test and added more accessibility improvements
- Updated linked images to have obvious focus styles
- Added proper role to notifications
- Made dropdown list focus styles a bit nicer.
- Updated book list chapter child slide down to be keyboard activatable.

Related to #1320
ssddanbrown added a commit that referenced this issue Aug 26, 2019
ssddanbrown added a commit that referenced this issue Aug 26, 2019
Tweaked entity color palette for accessibility
Also converted entity colors to CSS variables for easier
instance customization.

Related to #1320

@ssddanbrown ssddanbrown self-assigned this Aug 26, 2019


This comment has been minimized.

Copy link

commented Aug 26, 2019

Well this has been an interesting thing to work on. A lot of learnings that'll likely change how I do a lot of UI work going forward. Work done for this in the following commits:

There have been quite a few design, functional and code changes to enhance accessibility. I discovered many dynamic elements in BookStack were not keyboard navigable, Most of which have been updated. The core layout elements have changed to better use HTML that indicates purpose. The default BookStack colors are also changing to meet Level A standards.

Things are not fully compliant, but we're a lot further along now. I have updated the project readme with information on accessibility. The main troublesome spot I think is the page editors themselves but I'll do a deeper review when we look to better align the two editors. As said above, As it stands I won't really be able to guarantee a level of compliance but we can definitely keep it in mind, make targeted improvements and review parts of the system every so often.

I'll close this issue off now since large general overall improvements have been made. For further improvements I'll allow focused issues to be raised.

These changes will be part of the next release, V0.27.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
You can’t perform that action at this time.