new-dirham-symbol
Version:
A simple package to use the new UAE Dirham symbol with a custom font.
70 lines (46 loc) • 1.64 kB
Markdown
# UAE Dirham Symbol NPM Package
This package provides the **UAE Dirham (AED)** symbol using a custom font. The symbol is represented using the Unicode character **ê** (`U+00EA`) and is easy to integrate into your websites and applications through this NPM package.
## Features
- Custom UAE Dirham symbol font
- Simple integration with CSS via NPM
- Easy to use
## Installation
Install the package using npm:
```bash
npm i new-dirham-symbol
```
Or using Yarn:
```bash
yarn add new-dirham-symbol
```
## Usage
### **Using the Provided Stylesheet**
You can import the pre-built stylesheet directly into your project using NPM:
```css
@import 'new-dirham-symbol/dist/uae-symbol.css';
```
Then use it in your HTML:
```html
<span class="dirham-symbol">ê</span> 10,000
```
## Usage Guidelines
To maintain visual consistency, follow these guidelines:
- **Position**: Place the UAE Dirham symbol to the left of the numeral.
- **Spacing**: Leave a space between the symbol and the number.
- **Proportions**: Keep the symbol proportional without distortion.
- **Alignment**: Align the symbol height with surrounding text.
- **Direction**: Ensure the symbol follows the text direction.
- **Contrast**: Maintain sufficient contrast for visibility.
## Contributing
Contributions are welcome! Feel free to submit a pull request or open an issue if you have suggestions or improvements.
## Connect with Me
[My LinkedIn Profile](https://linkedin.com/in/abdulrehmanyaser)
## License
This project is licensed under the **MIT License**.