Skip to content

The target of Orange Confort+ functionalities is to enhance user experience on web sites, which are already accessible, or still accessible. Orange Confort+ provides these services : Typography - user may change: font size, space between words, characters and lines, font-face to Open Dislexic Layout: cancel layout, text align left, numbering lis…

License

Notifications You must be signed in to change notification settings

Orange-OpenSource/Orange-Confort-plus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orange-Confort-plus

Orange Confort+ aims to enhance user experience on websites. It works best when said websites are fully accessible.

Caution

Orange Confort+ does not improve website accessibility: blocking points still stay blocking points, with or without Orange Confort+.

Table of contents

Browser extension

Deploying Orange Confort+ on your website

To deploy Orange Confort+ onto your domain, a prepackaged version is available: simply add the dist/serveur folder to your website.

Call Confort+

To initialize Confort+, call it before the body closing tag using the correct path:

	<script src="/js/toolbar.min.js"></script>
</body>

Customize path

Important

If dist/serveur/ content is placed at your website root, you do not need the following action.

Declare customAppPath before including Confort+:

	<script>const customAppPath = `${window.location.origin}/my-custom-path/`;</script>
	<script src="/my-custom-path/js/toolbar.min.js"></script>
</body>

Note

User settings are saved in localStorage, thus depend on your domain. They are never shared with other websites, or extension.

Contribute

Clone

git clone https://github.com/Orange-OpenSource/Orange-Confort-plus.git

Install dependencies

npm ci

Start local server

npm start

It should build all the things and open your browser to http://localhost:9010. You're ready to update files in /src: any changes will trigger a build and reload your browser. For mor specific needs, take a look at existing scripts in our package.json.

Build all the things

To build HTML, CSS, JS and static assets for both the docs and the extension, run:

npm run build

Extension-specific scripts

We're using Mozilla's web-ext to ease our development workflow.

Package extension

A packaging script based on web-ext build exists for both Firefox and chromium, taking care of their specific manifest.json using npm pre-hook.

npm run zip

Lint extension

Based on web-ext lint (using addons-linter under the hood), we're linting the Firefox package.

npm run lint:ext

Load extension

web-ext run is used to load extension. There's a separate script for Firefox and Chrome.

npm run load:firefox
npm run load:chrome

Warning

As of today, those scripts are quite buggy on Ubuntu if you use Firefox through snap. See #108 for more context.

Work on Confort+ website

If you need to work on Confort+ very own website, there's a specific script:

npm run start:docs

Bugs and feature requests

Have a bug or a feature request? Please first check the issues and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Copyright and license

Code copyright 2014 - 2025 Orange. Code released under the GPLV2 license.

Credits

Font credits

Pictogram Credits

The accessibility icons for usage modes provided by Comfort+ are declared in the ISO 11581-7:2024 standard and are distributed under the Creative Commons CC0-1.0 licence.

About

The target of Orange Confort+ functionalities is to enhance user experience on web sites, which are already accessible, or still accessible. Orange Confort+ provides these services : Typography - user may change: font size, space between words, characters and lines, font-face to Open Dislexic Layout: cancel layout, text align left, numbering lis…

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 16