N:B : This package utilizes TailwindCSS for styling, please ensure tailwind is already installed in your project before installing this package.

Getting started

Installation

This package can be installed using npm

npm install @clefayomide/ui-currency-converter

or, yarn

yarn add @clefayomide/ui-currency-converter

Usage

Edit content array in tailwind.config.js to target path

content: [
  './node_modules/@clefayomide/ui-currency-converter/**/*.{js,jsx,ts,tsx}',
  // ...other paths according to tailwind configuration
];

Import Converter and AppState.

import { Converter, AppState } from '@clefayomide/ui-currency-converter';

Wrapping things up

<AppState>
  <Converter />
</AppState>

Props

Available props:

| Prop | Description | | -------------- | -------------------------------------------------------------------------------------------- | | buttonBG | overrides convert button default background color, must be in HEX format. i.e, #ffffff | | buttonHeight | overrides convert button default height, preferably in px or rem format. i.e, 12px || 3rem |

Disclaimer

This package utilized Fawaz Ahmed currency converter API and Rest Countries API, respectively.

Issues

If any issues are found, they can be reported here.

License

This project is licensed under the MIT license.