Skip to content

SeeSharpSoft/MMM-InteractiveGrid

Repository files navigation

MMM-InteractiveGrid

This is a lightweight module for MagicMirror² to show an interactive grid with custom content.

Installation

Install

In your terminal, go to your MagicMirror² Module folder and clone MMM-Overlay:

cd ~/MagicMirror/modules
git clone https://github.com/SeeSharpSoft/MMM-InteractiveGrid.git

Update

cd ~/MagicMirror/modules/MMM-InteractiveGrid
git pull

Using the module

Config

To use this module, add it to the modules array in the config/config.js file:

    {
        module: "MMM-InteractiveGrid",
        position: "top_bar",
        config: {
          maxColumns: 12,
          maxRows: 12
        }
    }

Configuration options

Option Possible values Default Description
maxColumns number 12 Maximum columns of the grid
maxRows number 12 Maximum rows of the grid

Sending notifications to the module

By default, the overlay is not active/visible. Its visibility can be controlled by sending notifications.

Notification Description
INTERACTIVE_GRID.CONTENT The payload is the content to be shown in the grid

Developer commands

  • npm install - Install devDependencies like ESLint.
  • npm run lint - Run linting and formatter checks.
  • npm run lint:fix - Fix linting and formatter issues.