Skip to content

Latest commit

 

History

History
106 lines (79 loc) · 2.78 KB

README.md

File metadata and controls

106 lines (79 loc) · 2.78 KB
Raw

meteor-connection-banner

A banner that displays when meteor server is disconnected with countdown and reconnect option.

Usage

{{>connectionBanner}} (best located right after the opening body tag)

This package will look best with supporting packages font-awesome and bootstrap-3

With font-awesome and bootstrap 3

Without either or both of these packages, it is still quite useful, but unstyled and plain

Without font-awesome and bootstrap 3

Element IDs can be used to directly style the banner if needed #connection-lost-banner and #connection-try-reconnect

Customizing Banner Text

The connection banner will attempt to fetch custom text from Meteor.settings. If any value is not set, the default value for that text will be used. Below are example settings which cover all of the text in the banner.

{
	"public":{
		"connectionBanner":{
			"connectionLostText":"Ooops. Something is wrong.",
			"tryReconnectText":"Try to reconnect now",
			"reconnectBeforeCountdownText":"Attempting to reconnect in",
			"reconnectAfterCountdownText":"seconds."
		}
	}
}

Settings are only required if you desire customized text

####Using with a Bootstrap Fixed Top Navbar

If you have a fixed navbar at the top of the page, the connectionBanner will render invisibly behind it. You can use the following CSS to move the navbar down if the banner is rendered (or appear below the navbar).

#connection-lost-banner + .navbar-fixed-top,
#connection-try-reconnect + .navbar-fixed-top {
    top: 41px;
}
.navbar-fixed-top + #connection-lost-banner,
.navbar-fixed-top + #connection-try-reconnect {
    top: 51px;
}

And insert the template either directly before or after the navbar element, e.g.:

{{>connectionBanner}}
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
  ...
</div>

Version History

###v0.5.2

  • Better background loading of font awesome icons

###v0.5.1

  • Upgraded example to Meteor 1.4

###v0.5

  • Ported to Meteor 1.0
  • Replaced all session variables with reactiveVars
  • Refactored helper code

###v0.4

  • Fixed a typo in default text
  • Text can now be cusomtized via Meteor.settings

###v0.3

  • Eliminated extra update intervals, just 1 interval at any time now

###v0.2

  • Adjustments to be blaze compatible
  • Renamed some element IDs
#meteor-connection-lost-banner -> #connection-lost-banner
#meteor-connection-try-reconnect -> #connection-try-reconnect
  • Renamed base template
meteorConnectionBanner -> connectionBanner
  • Removed handlebars helper in favor of sub template include
{{meteorConnectionBanner}} -> {{>connectionBanner}}

###v0.1

  • Initial Release