Skip to content

Latest commit

 

History

History
148 lines (100 loc) · 5.95 KB

README.md

File metadata and controls

148 lines (100 loc) · 5.95 KB

eBay Translation Widget

Lightweight, responsive, and fully-customizable component for React applications to translate eBay item title and description to another language.

Note: The translation is powered by eBay Translation API.

Table of contents

Motivation

eBay Translation Widget is a fully customizable React component that allows you to translate eBay item title and description to another language.

This component provides a responsive UI experience with two different modes:

  • Translation by Text: Simply enter the eBay item title/description in the textbox, set the translation context and click the Translate button

Translation by Text - Title

Translation by Text - Description

Translation by eBay item number

It comes with a ready to use example and a NodeJS express server to bootstrap integration with eBay Translation API.

Features

  • Supports two different modes:
    • Translate by text
    • Translate by eBay listing/item ID
  • The widget currently supports nine languages and the to/from permutations can be easily updated in SupportedTranslations.js
  • API errors/warnings are displayed as alerts and can be overridden

Usage

Prerequisites

- NodeJS (for the example): v16 or higher
- NPM: v7.5.6 or higher/Yarn: v1.22.10 or higher

Install

NPM Version

Using npm:

npm install ebay-translation-react-widget

Using yarn:

yarn add ebay-translation-react-widget

Configure

Before when running the example, make the following updates to the options.js file:

API

Prop Description Type Default Required
backendEndpoint Backend server URL String "" Y
errorMessage Overrides the error message String "" N
hideErrors When passed this will hide the error message alerts Boolean false N
hideWarnings When passed this will hide the warning message alerts Boolean false N
warningMessage Overrides the warning messages String "" N

Example

import EbayTranslationWidget from 'ebay-translation-react-widget';

<EbayTranslationWidget backendEndpoint="http://localhost:3001/translate"
/>

Running the example

Using npm:

npm start

Using yarn:

yarn start

Configuration Sample: options.js.

Note for Production deployment

For production, please host with HTTPS enabled.

Logging

Uses standard console logging.

License

Copyright 2021 eBay Inc. Developer: Lokesh Rishi

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.