> For the complete documentation index, see [llms.txt](https://blueeast.gitbook.io/bluerain-plugin-launcher/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-launcher/master.md).

# bluerain-plugin-launcher

Adds launcher screen with apps available in app registry. This plugin replaces bluerain-os IndexPage component with its own component.<https://blueeast.gitbook.io/bluerain-plugin-launcher>

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

## Screenshot

|   Type   |                                                                                                        Example 1                                                                                                       |
| :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|    Web   | ![Launcher](https://3277255408-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LHYKhSc53KZ_FUlTDMF%2F-LTh93b8mhGMRHDzbWcw%2F-LTh94PtaDmF51noC4vk%2FLauncher.png?generation=1544798362378432\&alt=media) |
| Electron |                                                                                                           TBD                                                                                                          |
|  Native  |                                                                                                           ✖️                                                                                                           |

## Usage

Run the following command:

```
yarn add @blueeast/bluerain-plugin-launcher
```

## Example

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

  <BR.Components.IndexPage/>
```

## Components

### IndexPage

#### **Props**

| Name         | Default | Type   | Description                               |
| ------------ | ------- | ------ | ----------------------------------------- |
| selectedView | 'grid'  | string | This is the style to show in the Launcher |
| match        |         | object | It is used for routing of the Page        |

## API

### LauncherPlugin

### **Extends Plugin**

Launcher Plugin

### **Properties**

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