README.md from fewieden/MMM-Modal

README.md
Summary

Maintainability

Test Coverage

Issues
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/fewieden/MMM-Modal/master/LICENSE) ![Build status](https://github.com/fewieden/MMM-Modal/workflows/build/badge.svg) [![Code Climate](https://codeclimate.com/github/fewieden/MMM-Modal/badges/gpa.svg?style=flat)](https://codeclimate.com/github/fewieden/MMM-Modal) [![Known Vulnerabilities](https://snyk.io/test/github/fewieden/mmm-modal/badge.svg)](https://snyk.io/test/github/fewieden/mmm-modal)

# MMM-Modal

Modal window Module for MagicMirror²

## Example

![](.github/example.png) ![](.github/example_dialog.png)

## Dependencies

* An installation of [MagicMirror²](https://github.com/MichMich/MagicMirror)
* OPTIONAL: [Voice Control](https://github.com/fewieden/MMM-voice)

## Installation

* Clone this repo into `~/MagicMirror/modules` directory.
* Configure your `~/MagicMirror/config/config.js`:

```js
{
    module: 'MMM-Modal',
    position: 'fullscreen_above',
    config: {
        // all your config options, which are different than their default values
    }
}
```

## Config Options

| **Option** | **Default** | **Description** |
| --- | --- | --- |
| `timer` | `15000` | Either `false` (buttons/voice control) or milliseconds how long a modal should remain open. |
| `touch` | `false` | Flag to enable touchable buttons fot closing the modal or handle dialogs. |
| `showSenderName` | `true` | Flag to display the name of the sender module or not. |

## OPTIONAL: Voice Control

This module supports voice control by [MMM-voice](https://github.com/fewieden/MMM-voice).
In order to use this feature, it's required to install the voice module. There are no extra config
options for voice control needed.

### Mode

The voice control mode for this module is `MODAL`

### List of all Voice Commands

* OPEN HELP -> Shows the information from the readme here with mode and all commands.
* CLOSE HELP -> Hides the help information.
* CLOSE MODAL -> Closes the open modal.
* CANCEL MODAL -> Cancel the dialog.
* CONFIRM MODAL -> Confirm the dialog.

## Depending Modules

List of all modules depending on MMM-Modal in the [Wiki](https://github.com/fewieden/MMM-Modal/wiki/Depending-Modules).

## Developers

If you want to integrate MMM-Modal into your own modules, then please check out the developer [guide](DEVELOPER.md)

* `npm run lint` - Lints JS and CSS files.
* `npm run docs` - Generates documentation.