https://github.com/vidigal-code/bpt-pro-libretranslate
An open-source browser translation plugin offers real-time translation, supports multiple languages, and automatically detects and translates text into the user’s preferred language. It uses the LibreTranslate API and is continuously improved by the community to stay updated and optimized.
https://github.com/vidigal-code/bpt-pro-libretranslate
browser-extension css html javascript libretranslate
Last synced: about 1 month ago
JSON representation
An open-source browser translation plugin offers real-time translation, supports multiple languages, and automatically detects and translates text into the user’s preferred language. It uses the LibreTranslate API and is continuously improved by the community to stay updated and optimized.
- Host: GitHub
- URL: https://github.com/vidigal-code/bpt-pro-libretranslate
- Owner: Vidigal-code
- License: mit
- Created: 2025-01-18T12:40:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-08T20:13:11.000Z (over 1 year ago)
- Last Synced: 2025-03-08T20:23:31.865Z (over 1 year ago)
- Topics: browser-extension, css, html, javascript, libretranslate
- Language: JavaScript
- Homepage:
- Size: 5.35 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BPT-Pro-Libretranslate
**BPT-Pro-Libretranslate** is a project developed to provide a powerful text translation tool, using the best available
translation APIs. This project allows users to configure the API URL, set the desired target language, and quickly
translate selected text on web pages.
## Example
## Features
- **API Configuration**: Configure the API URL and API key for translation services.
- **Multiple Language Support**: Translate text into various languages, such as English, Spanish, French, Portuguese,
and more.
- **Popup Display**: Displays translations in an elegant popup on the screen after selecting text on a webpage.
- **User-Friendly Interface**: The extension provides a simple interface for users to manage settings and customize
their translation experience.
## Installation
### Steps to Install
1. **Download or Clone the Repository**:
- You can either download the ZIP file of the repository or clone the repository using Git:
```bash
git clone https://github.com/Vidigal-code/BPT-Pro-Libretranslate.git
```
2. **Load the Extension in Chrome or Edge**:
- Open your browser and go to the extensions page (`chrome://extensions` for Chrome or `edge://extensions` for
Edge).
- Enable Developer Mode (toggle in the top-right corner).
- Click on **Load Unpacked** and select the folder where you downloaded or cloned the repository.
4. **Configure the Extension**:
- Click on the extension icon in the browser toolbar.
- Enter the API URL and the API key for the translation service.
- Select the target language for translation.
- API Test: https://translate.fedilab.app/translate
- API Test Key: unknown
### Start Using
Once configured, simply select text on any webpage, and the translation will appear in a popup.
## Usage
1. **Select Text**: Highlight the text on a webpage.
2. **Translation Popup**: The translation of the selected text will appear in a popup.
3. **Close Popup**: Click the "X" button on the popup to close it.
4. **Configure Settings**: If needed, you can change the API URL, API key, or target language via the settings page.
5. **Plugin Status**: Activate the plugin.
## Example Code
```javascript
async function translateText(text, targetLanguage, apiUrl, apiKey) {
const response = await fetch(apiUrl, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/x-www-form-urlencoded',
},
body: new URLSearchParams({
q: text,
source: 'auto',
api_key: apiKey,
target: targetLanguage,
format: 'text'
}),
});
const data = await response.json();
if (data.error) {
// console.error('Translation API error:', data.error);
return `Error: ${data.error}`;
}
return data.translatedText;
}
```
To implement the keyboard shortcuts you mentioned in your code (`Alt + A` to activate the plugin, `Alt + K` to
deactivate the plugin, `Alt + G` to toggle the plugin status, and `Alt + T` to test or open the test connection menu),
you can modify the existing `setupKeyboardShortcuts` function. Here’s the updated version of the code with these
specific shortcuts added:
```javascript
/**
* Sets up keyboard shortcuts to activate/deactivate the plugin, test connection, and toggle the plugin status.
*/
setupKeyboardShortcuts()
{
document.addEventListener('keydown', (event) => {
if (event.altKey) {
switch (event.key.toUpperCase()) {
case 'A': // Alt + A to activate the plugin
this.togglePluginStatus(true);
break;
case 'K': // Alt + K to deactivate the plugin
this.togglePluginStatus(false);
break;
case 'G': // Alt + G to toggle the plugin status (activate if deactivated, deactivate if active)
event.preventDefault();
this.togglePluginStatus();
break;
case 'T': // Alt + T to open the test connection menu
event.preventDefault();
const apiTestPopup = new ApiTestPopup();
apiTestPopup.createApiTestListPopup();
break;
default:
break;
}
}
});
}
```
### Explanation of the Key Shortcuts:
1. **Alt + A**: Activates the plugin (calls `togglePluginStatus(true)`).
2. **Alt + K**: Deactivates the plugin (calls `togglePluginStatus(false)`).
3. **Alt + G**: Toggles the plugin status. If it is active, it will deactivate it; if it is inactive, it will activate
it (calls `togglePluginStatus()`).
4. **Alt + T**: Opens the test connection menu by calling the `ApiTestPopup` constructor and its
`createApiTestListPopup` method.
This will allow users to control the plugin's activation and deactivation with keyboard shortcuts, providing a more
seamless user experience. Make sure that the `togglePluginStatus` function and `ApiTestPopup` class are properly
implemented in your project for this to work correctly.
## Technologies Used
- **HTML**: Used to create the extension’s settings page and popup.
- **CSS**: Used to style and create a responsive interface for the extension.
- **JavaScript**: Handles the logic for translating selected text and manages the interactions between the extension and
the browser.
- **Chrome/Edge Extension APIs**: Allows communication between the browser and the extension, manages storage of
settings, and handles the popup behavior.
# License
This project is licensed under the **MIT License**.
See the [LICENSE](https://github.com/Vidigal-code/BPT-Pro-Libretranslate/blob/main/License.mit) file for more details.
# License - API
This project is licensed api under the **MIT License**.
See the [LICENSE](https://github.com/LibreTranslate/LibreTranslate/blob/main/LICENSE) file for more details.
---
## Credits
- **Creator**: Kauan Vidigal
- **Translation API**: [LibreTranslate](https://libretranslate.com/)
- **Contributions**: Contributions are welcome! Feel free to fork the repository, open an issue, or submit a pull
request for improvements or new features.
## Links
- [LibreTranslate API Documentation](https://libretranslate.com/docs)
- [LibreTranslate API GitHub](https://github.com/LibreTranslate/LibreTranslate)
---
Feel free to modify and enhance this project to suit your needs!