0.0.4 • Published 6 months ago

@sikka/alam v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

alam-readme-1

ALAM

SVG Country Flags for React (Package Name)

Description

This NPM package provides a collection of SVG country flags, optimized for React applications and written in TypeScript. It offers a simple and efficient way to include scalable, high-quality flag icons in your web projects.

Features

  • High-quality SVG flags for a wide range of countries.
  • Easy integration with React projects.
  • TypeScript support for type safety and autocompletion.
  • Lightweight with minimal dependencies.

Installation

To install the package, run the following command in your project directory:

npm install @sikka/alam --save

Usage

Import the flag component in your React application:

import { SA } from '@sikka/alam';

const MyComponent = () => (
  <div>
    <SA />
  </div>
);

export default MyComponent;

Props

PropTypeDescriptionRequired
countryCodestringISO Alpha-2 country codeYes
widthstringWidth of the flag (in pixels)No
heightstringHeight of the flag (in pixels)No
classNamestringAdditional CSS class for stylingNo

Contributing

We welcome contributions to this package. If you have a suggestion or fix:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/AmazingFeature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some AmazingFeature').
  5. Push to the branch (git push origin feature/AmazingFeature).
  6. Open a pull request.

License

Distributed under the MIT License. See LICENSE file for more information.

Acknowledgments

0.0.4

6 months ago

0.0.3

6 months ago

0.0.2

6 months ago

0.0.1

6 months ago