jonhleno / volto-vlibras

An addon integrating the VLibras service into a Plone site running Volto

VLibras support for Plone

This addon integrates VLibras, a service for automatic translation of web content into Lingua Brasileira de Sinais, in a Plone project using Volto user interface.

Screenshots

Opening VLibras Widget

Using the Widget

Install

New Volto Project

Create a Volto project

npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @plonegovbr/volto-vlibras
cd my-volto-project

Existing Volto Project

If you already have a Volto project, just update package.json:

"addons": [
    "@plonegovbr/volto-vlibras"
],

"dependencies": {
    "@plonegovbr/volto-vlibras": "*"
}

Configuration

To inject the component in the project add the appextras configuration in the config.js file.

A suggested way is to use appExtras from settings object (docs):

import '@plone/volto/config';
import Libras from '@plonegovbr/volto-vlibras/components/Libras';

export default function applyConfig(config) {

  config.settings = {
    ...config.settings,
    appExtras: [
      ...config.settings.appExtras,
      {
        match: '',
        component: Libras,
      },
    ],
  }

  return config;
  
};

Test it

After adding the add-on, and its configuration, you need to install it and then start the project:

yarn install
yarn start

Then go to http://localhost:3000/

Contribute

• Issue Tracker
• Source Code

Credits

The development of this add on was sponsored by the Brazilian Plone Community

License

The project is licensed under MIT.