Can I integrate Eye-Able features through custom buttons?
Yes, you can create your own buttons and link them to the available assistance functions via the Eye-Able® JavaScript API. This allows you to call functions directly from your own user interface and adapt them to your website’s design.
Most of the functions of Eye-Able® can be accessed through the Eye-Able® API. With the help of your own scripts, you can creatively integrate these functions into your website. For example, individual functions such as night mode or the blue light filter can be linked to your own control elements.
Structure of the API
All functions are part of the EyeAbleAPI object.
They must therefore be called using this reference.
Example:
// Example of calling a function from the Eye-Able API
EyeAbleAPI.resetAll();
This function resets all active Eye-Able settings.
Events and Initialization
As soon as the Eye-Able plugin has been successfully initialized, the event"eyeable:init_completed" is triggered.
You can use this event to execute your own functions once Eye-Able has loaded.
Example:
// Execute a custom function once Eye-Able has been initialized
document.addEventListener("eyeable:init_completed", func);
Commonly Used Functions (Examples)
Toggle Toolbar
Opens or closes the Eye-Able toolbar:
EyeAbleAPI.toggleToolbar();
Toggle Contrast
Switches the currently selected contrast mode:
EyeAbleAPI.toggleContrast();
Reset All Active Functions
EyeAbleAPI.resetAll();
All functions available in the API, along with further examples, can be found in the technical documentation:
Support
If you need assistance with implementation, we are happy to help.
Integration requires only a small one-time development effort.
If you have any questions or need support, our support team is always available to assist you.