https://github.com/movahhedi/lestin-fontawesome

https://github.com/movahhedi/lestin-fontawesome

List: lestin-fontawesome

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/movahhedi/lestin-fontawesome
• Owner: movahhedi
• License: mit
• Created: 2024-08-21T14:39:44.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-12-07T11:15:35.000Z (about 1 month ago)
• Last Synced: 2024-12-07T12:18:56.119Z (about 1 month ago)
• Language: TypeScript
• Size: 76.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FontAwesome Component for Lestin

FontAwesome icons component for JS/TS/[Lestin](https://github.com/movahhedi/lestin).

## Installation

Install it via [npm](https://www.npmjs.com/package/@lestin/fontawesome):

```bash

npm install @lestin/fontawesome

```

Or yarn:

```bash

yarn add @lestin/fontawesome

```

Or pnpm:

```bash

pnpm add @lestin/fontawesome

```

## Usage

```tsx

import { FontAwesome } from "@lestin/fontawesome";

const box =

	


		

	


```

## Props

`FontAwesome` accepts these props:

- `icon` (string, required): The name of the FontAwesome icon to be rendered. If the icon name does not start with `fa-`, it will be automatically prefixed with `fa-`.

- `class` (string, optional): Additional CSS classes to be applied to the icon.

- `solid` (boolean, optional): If true, applies the "fa-solid" class to the icon.

- `brands` (boolean, optional): If true, applies the "fa-brands" class to the icon.

- `duotone` (boolean, optional): If true, applies the "fa-duotone" class to the icon.

- `light` (boolean, optional): If true, applies the "fa-light" class to the icon.

- `regular` (boolean, optional): If true, applies the "fa-regular" class to the icon.

- `thin` (boolean, optional): If true, applies the "fa-thin" class to the icon.

## Usage

```jsx

import { FontAwesome } from "@lestin/fontawesome";

const socialsElement (

	


		

		

		

		

		

		

		

		

		

	

);

```


The `class` prop allows you to add any additional CSS classes to the icon for further customization.

```jsx

import { FontAwesome } from "@lestin/fontawesome";

const customElement = (

	


		

	

);

```