> For the complete documentation index, see [llms.txt](https://blueeast.gitbook.io/bluerain-plugin-vector-icons/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://blueeast.gitbook.io/bluerain-plugin-vector-icons/master.md).

# bluerain plugin vector icon

![Vector Icons for React Native](https://cloud.githubusercontent.com/assets/378279/12009887/33f4ae1c-ac8d-11e5-8666-7a87458753ee.png) Customizable Icons for BlueRain Apps from [react-native-vector-icons](https://oblador.github.io/react-native-vector-icons/) with support for NavBar/TabBar/ToolbarAndroid, image source and full styling. [**bluerain-plugin-vector-icons**](https://blueeast.gitbook.io/bluerain-plugin-vector-icons)

| 🌏 Web | 🖥 Electron | 📱 React Native |
| ------ | ----------- | --------------- |
| ✔️     | ✔️          | TBD             |

## Screenshots

| Type     | Example 1                                   | Example 2                                   |
| -------- | ------------------------------------------- | ------------------------------------------- |
| Web      | ![vectoricons](/files/-LHb0jyNOSuHXE3Zgok5) | ![vectoricons](/files/-LHb0jyPDvelrBcj7NU4) |
| Electron | TBD                                         | TBD                                         |
| Native   | TBD                                         | TBD                                         |

## Installation

Run the following command in the plugin directoy:

```
yarn add  @blueeast/bluerain-plugin-vector-icons
```

## Components

### Icon

#### **Props**

| Name | Default | Type   | Description                           |
| ---- | ------- | ------ | ------------------------------------- |
| name |         | string | This is used for the name of the Icon |
| size |         | string | This is used  for size of the icon    |

#### **Example:**

```
import BR from '@blueeast/bluerain-os';

<BR.Components.Icon name="airplane" size={30} color="blue" />
```

### [Demo](https://BlueEastCode.github.io/bluerain-plugin-vector-icons/)

## API

### VectorIconsFontAwesome

### **Extends** [**Plugin**](https://blueeast.gitbook.io/bluerain-os/api/api-reference#plugin)

#### **Properties**

* `pluginName` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) "VectorIconsFontAwesome"
* `slug` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) "vector-icons-font-awesome"

### VectorIconsEntypo

### **Extends** [**Plugin**](https://blueeast.gitbook.io/bluerain-os/api/api-reference#plugin)

#### **Properties**

* `pluginName` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)  "VectorIconsEntypo"
* `slug` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) "vector-icons-Entypo"

### VectorIconsIonicons

### **Extends** [**Plugin**](https://blueeast.gitbook.io/bluerain-os/api/api-reference#plugin)

#### **Properties**

* `pluginName` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) "VectorIconsIonicons"
* `slug` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) "vector-icons-Ionicons"

### VectorMaterialCommunityIcons

### **Extends** [**Plugin**](https://blueeast.gitbook.io/bluerain-os/api/api-reference#plugin)

#### **Properties**

* `pluginName` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) "VectorMaterialCommunityIcons"
* `slug` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)  "vector-materialCommunity-icons"

### VectorIconsMaterialIcons

### **Extends** [**Plugin**](https://blueeast.gitbook.io/bluerain-os/api/api-reference#plugin)

#### **Properties**

* `pluginName` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) "VectorIconsMaterialIcons"
* `slug` [**string**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)  "vector-icons-material-icons"