This project is not covered by Drupal’s security advisory policy.
Readable Reader integrates the Readable accessibility reader with Drupal. It adds a configurable reading widget to entity displays, Views, or block regions without storing data in a field.
Features
Readable Reader integrates the Readable accessibility reader with Drupal. It allows site builders to add the Readable Reader widget without creating a database field or storing additional data on content.
The widget can be added in three ways:
- Entity view displays: Adds a
readable_readerextra field to content type and taxonomy vocabulary view displays. The field can be enabled, disabled, reordered, or hidden for each display. - Views: Provides a global Readable reader area that can be added to a view header or footer. It works with regular Views and Views based on Search API indexes, rendering the widget once per display rather than once for every result row.
- Block placement: Provides a
readable_reader_blockblock that can be placed in any block region.
Use this module when you want to provide Readable's reading and accessibility functionality on Drupal content, taxonomy pages, Views, search results, or other site areas without adding custom fields or custom templates.
Post-Installation
After installing and enabling the module, go to /admin/config/services/readable-reader and configure the Readable integration.
The configuration form includes the following settings:
- Enable: Enables or disables the Readable Reader integration.
- Source URL: The absolute URL of the Readable loader. The URL must use the
/widget/loader.jspath. - Portal: The portal domain registered in the Readable administration.
- Site ID: The site identifier provided by the Readable administration.
- Target selector: The CSS selector used as the target for the inline reader button. The default selector is
.field--name-field-readable. - Subresource Integrity: An optional integrity hash for the external loader.
- Cross-origin setting: The
crossoriginattribute used by the external loader.
Once the portal settings have been configured, enable the extra field in the required entity view displays, add the global area to a Views header or footer, or place the Readable Reader block in a block region. The widget is rendered only when the integration is enabled and the selected integration has been enabled or placed in the current display.
Additional Requirements
- Drupal 10 or Drupal 11.
- Drupal core Views module, which is required by this project.
- An active Readable portal with a valid site ID.
- Access to the configured external Readable loader URL. The module loads the Readable widget from the external
/widget/loader.jsresource.
Recommended modules/libraries
No additional Drupal modules or libraries are required or specifically recommended. The module uses the external Readable Reader loader configured in its settings.
Similar projects
No directly equivalent Drupal project is documented. Readable Reader provides an integration with the external Readable accessibility service and focuses on flexible placement through entity view displays, Views headers and footers, and block regions. It does not store content in a custom field or add a separate content type.
Supporting this Module
There is currently no dedicated Patreon, OpenCollective, or other sponsorship link for this project. Contributions, feedback, and bug reports are welcome through the project's Drupal.org issue queue.
Community Documentation
- Readable official website.
- Readable Reader issue queue on Drupal.org.
Project information
- Project categories: Content display
2 sites report using this module- Created by pascuperbla on , updated
This project is not covered by the security advisory policy.
Use at your own risk! It may have publicly disclosed vulnerabilities.
