Skip to content
This repository has been archived by the owner on Jul 3, 2020. It is now read-only.

Latest commit

 

History

History
94 lines (66 loc) · 3.62 KB

README.md

File metadata and controls

94 lines (66 loc) · 3.62 KB
Raw

/!\ This package is not maintained anymore /!\

Meteor Status

What is it?

Meteor Status is a package which automatically alerts users when the connection to the server has been lost. It also shows a countdown (in seconds) until the next retry and allows users to manually retry in the meantime.

Here is how it looks like:

Meteor Status screenshot

This package should be compatible with packages like Smart Disconnect as the alert does not show up in case of a manual disconnect (triggered with Meteor.disconnect()). Also, the first connection attempt (when the application is loaded for the first time) only shows the alert message on mobile (Cordova).

Installation

Add the package in your Meteor application with this command:

meteor add 255kb:meteor-status

Usage

Add the template before the body closing tag or anywhere else if you use the option style=false (see below):

<body>
    ...
    {{> meteorStatus}}
</body>

Options

You can add the following options to the template:

  • style=true: remove style/UI/positioning (only displays the text and the link)
  • lang='en': change language (currently 'fr', 'en', 'es', 'zh' and 'ar' supported, default to 'en')
  • position='bottom': change positioning for styled version ('top' or 'bottom', default to bottom)
  • showLink=true: display the retry link or not (true or false, default to true)
  • msgText='... %delay% ...': (for backward compatibility only, use textDisconnect and textConnecting below) override the message (add '%delay%' in the string to insert the number of seconds until the next retry)
  • textDisconnect='... %delay%' ...: override the message when disconnected and waiting for retry (add '%delay%' in the string to insert the number of seconds until the next retry)
  • textConnecting='...: override the message when reconnecting
  • linkText='...': override the link text
  • overlay=false: display a full screen semi transparent alert with centered text (true or false, default to false)

Example:

<body>
    ...
    {{> meteorStatus style=false lang='fr' position='top' showLink=false textDisconnect='Custom disconnected message' textConnecting='Custom connecting message' overlay=true}}
</body>

Changelog

v1.5.0:

  • add different text for status "connecting" which is showing instead of "... in 0s", customizable (new textConnecting and textDisconnected variables, compatible with old msgText variable) and with fr/en translations
  • correct a problem where the alert was not showing if the app was started with no connection (airplane mode)

v1.4.3:

  • added option to display the status bar as overlay

v1.4.2:

  • added Arabic language

v1.4.1:

  • added Spanish language

v1.4.0:

  • added option to show/hide the retry link
  • added the possibility to override the texts (message and link)

v1.3.2:

  • alert does not show on first connection on cordova anymore (avoid having the alert showed at every startup)
  • alert does not show on first retry when disconnected (avoid alert appearing too frequently when having a laggy mobile connection)

v1.3.1:

  • removed unneeded dependency (session)
  • new language (chinese)

v1.3.0:

  • package rewritten to allow multiple instances, also lighter
  • no more jquery dependency
  • higher z-index for styled version
  • ability to position to top
  • lighter unstyled version (text only, no wrapping div)

v1.2.0:

  • Improved default design (font and link style)
  • Option to disable UI/design (text only)
  • switch to local reactive vars instead of session vars
  • added i18n support and French language