https://github.com/andreymatveev/jquery-inline-currency
Simple jQuery plugin for showing prices in different currencies using actual exchange rates. | Demo: https://andreymatveev.github.com/jquery-inline-currency
https://github.com/andreymatveev/jquery-inline-currency
currencies exchange exchange-rate jquery jquery-plugin price rate
Last synced: 12 days ago
JSON representation
Simple jQuery plugin for showing prices in different currencies using actual exchange rates. | Demo: https://andreymatveev.github.com/jquery-inline-currency
- Host: GitHub
- URL: https://github.com/andreymatveev/jquery-inline-currency
- Owner: andreymatveev
- License: mit
- Created: 2015-10-15T17:34:40.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-12T12:03:50.000Z (almost 5 years ago)
- Last Synced: 2025-08-29T15:51:38.255Z (about 1 month ago)
- Topics: currencies, exchange, exchange-rate, jquery, jquery-plugin, price, rate
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jQuery.inline-currency
Simple jQuery plugin for showing prices in different currencies using actual exchange rates.
## How to use
- Install plugin using npm or manually
```
npm install jquery-inline-currency
```
- Include plugin in the `head` or `body` section after jQuery:
```
```
- Set styles for the currencies tooltip or include my version from `css/jquery.inline-currency.css`;
```
```
- Put each price into some element, that will be selector for jQuery:
```
$10
```
- Apply `inlineCurrency` plugin to your prices:
```
$(function () {
$('.jic').inlineCurrency();
});
```
## How it works
Plugin tries to detect price from text, so this setup will be best with integer or float prices.
If you use formatting for your numbers (thousands and decimal separators), you should set some options to plugin.
## Options
Default set:
```
{
"currency": "USD",
"convertTo": "EUR",
"thousandsSplit": "",
"decimalsSplit": ".",
"containerElement": "p",
"containerClass": "jic-container",
"rateElement": "span",
"rateClass": "jic-rate",
"currencyElement": "span",
"currencyClass": "jic-currency",
"currencySplit": false,
"debug": false
}
```
All parameters are optional.
### Currency setup
- `currency` — basic currency for your prices
- `convertTo` — comma-separated list of currencies to convert to
### Price recognition
- `thousandsSplit` - thousands separator (can be empty, space, `.` or `,`)
- `decimalsSplit` - decimals separator (can be empty, space, `.` or `,`)
Remember that this parameters can't be equal.
### Tooltip generation setup
- `containerElement` and `containerClass` - element that will be appended to each price
- `rateElement` and `rateClass` - element and class for each exchange rate
- `currencyElement` and `currencyClass` — element for each currency unit
- `currencySplit` (Boolean or String) — excludes `rateElement` and generates exchange rates separated by `currencySplit` value
## Inline parameters
Plugin also supports inline parameters (for exotic cases) which can help set price, base currency and convertTo for each price:
- `data-jic-value` - price value
- `data-jic-currency` — base currency
- `data-jic-convert-to` — comma-separated list of currencies to convert to
```
Ten Euros
```
## Exchange rates source
In the begining it was Yahoo Currencies Service, but in the discussion at `https://developer.yahoo.com/forum/General-Discussion-at-YDN/Using-Yahoo-Finance-API-Not-RSS-/1250246255000-0b82f8f0-7f48-3af2-8fe2-e73a138cbfaa/` it was mentioned:
> The reason for the lack of documentation is that we don't have a Finance API. It appears some have reverse engineered an API that they use to pull Finance data, but they are breaking our Terms of Service (no redistribution of Finance data) in doing this so I would encourage you to avoid using these webservices.
>
>Cheers,
>Robyn Tippins
>Community Manager, YDN
So, I've decided not to break Yahoo's Terms of Service and have found https://www.frankfurter.app/ (https://github.com/hakanensari/frankfurter). As it is free and has MIT License, it's the best choice for our purposes. Thanks, @hakanensari
## How often do rates update
Once a day (for now, since October 2015). Check https://github.com/hakanensari/frankfurter for more info.
## Browser compatibility
You can check `window.localStorage` use at http://caniuse.com/#search=localstorage