Skip to content

Client: ui utils.js

Brian Hanifin edited this page Jul 28, 2014 · 5 revisions

User Interface Utilities

I created ui-utils.js as a catch-all for the toolbar and settings drawer. It makes a lot of sense to merge dropdown.js with this file, so I just did that.

Some reusable functions are also included, such as showNotification() and lots of querystring parameters.

Querystring Parameters

Usage:

  • http://localhost:1337/?drawer=true
  • http://localhost:1337/?toolbar=false

For Users

  • ?drawer=true opens the drawer
  • ?mute=true use this carefully and this will mute all alarms!!!
  • ?toolbar=false hides the toolbar

For Developers

  • ?experiments=true hamburger?
  • ?notify=Hello,_world! underscores will become spaces
  • ?notify=Something_went_wrong!&notifytype=urgent

showNotification() & hideNotification()

This is a basic, home grown notification system. Notifications messages should be short and to the point. This is both for the sake of the users, and because the notification bar only has a single line for text and phone screens are narrow.

showNotification(note, notifytype)

Displays a notification message at the top center of the screen. On narrow phone screens it displays below the BG number. By default the background color is red, but is can be customized. See the notifytype explination below.

hideNotification()

Only one notification can be displayed at a time, so no parameters are needed. showNotification() calls this to clear the previous notification before adding a new one.

notifytype

Valid notifytype values are info, success, warn, urgent. Info has a blue background, success is green, warn is yellow, and urgent is red. When a notifytype is not specified, urgent is assumed.