windyplugin-module-infobox/README.md

common module for the infobox lower left screen

infobox module
==============

Box at the bottom left of the screen, hooked to the #bottom (desktop) or #mobile-calendar (mobile).

Import into plugin with:

```
import ib from "@windy/windy-plugin-module-infobox";
```

Call with:

```
this.refs.infobox = ib.makeInfoBox(
		    content, //string to be added
		    startId,  //id of the button/div to open the left pane
		    this,  //reference to the plugin calling the fx.
		    hideWhenPluginOpens   //default is false
        )
```

Returns reference to this div.  In my plugins I reference it to this.refs.infobox.  The windy plugin gallery will then set its style.display="none",  if another plugin opens.

In `config.js`:

Load as dependency from:  `'https://unpkg.com/windyplugin-module-infobox@x.x.x/dist/infobox.js' `
Check npm for the most recent version.

The code is here:

https://github.com/rittels/windy-plugins-modules/tree/master/infobox