Mercury Command Bar¶

The Mercury Command Bar allows rapid access to your work such as emails, meetings, recently opened files, and tasks.

There are also other features here to help you work more efficiently, such as a Favourites (or "Followed Content") manager, App launcher, and a customisable world clock.

Command Bar Configuration¶

Note

Version 1.5.0.0 of Mercury Command Bar now includes a Configure Mercury component which will be available when you're a site admin. Read the documentation on that component here. The rest of this page describes detailed configuration that underpins the Configure Mercury component.

Note

The Command Bar can manually be modified in the topbarconfig.json file, using valid JSON syntax.

You can customise which icons appear in the Command Bar, and choose what titles they appear with. Add this sample configuration below to your Top Bar Configuration as appropriate. This sample will only show the App Bar, with the title "Enterprise Applications", and the Task Manager, with the title "Task Manager"

Leaving out the Display Name will show the default title for that app.

Note

You MUST specify the itemKey using the list available further down the page. If you don't specify displayName, the default name will be used.

{
  // ... other config omitted for brevity
  "commandBarItems": [
      {
          "itemKey": "AppBar",
          "displayName": "Enterprise Applications"
      },
      {
          "itemKey": "MyTasks",
          "displayName": "Task Manager"
      }
  ]

This technique allows you to hide any apps from the Command Bar.

Full list of Command Bar Item Configuration values¶

Below is a list of available options for all Command Bar items:

Property	Description
`itemKey`	The internal name for this Command Bar item
`displayName`	The name that will be show as the title of the Panel this item displays
`panelSize`	Sets a custom width for the Panel that appears

Ticker-specific options¶

These options are specific to Announcements & Service Updates in configuring their Ticker options. See the chapter on Tickers for more info.

Property	Description
`showInlineInfo`	Set to `true` to display inline tickers for Announcements or Service Updates
`contentWidth`	Set a CSS width string to set a fixed width for the ticker
`contentTickerInterval`	Set to a number which will be the ticker interval time in milliseconds

Custom Panel Widths¶

You can set how wide the Command Bar item's Panel is using the panelSize property. Specify a string that describes how wide the Panel should be.

{
  "itemKey": "AssociatedSites",
  "panelSize": "350px"
}

Default Apps Config¶

If you want to use the full default config, but change the display names, you can use the following snippet. Simply add the "displayName" property within the appropriate block.

Click here to expand to see the full example

{
  // ... other config omitted for brevity
  "commandBarItems": [
      {
          "itemKey": "AssociatedSites"
      },
      {
          "itemKey": "AppBar"
      },
      {
          "itemKey": "MyFavourites"
      },
      {
          "itemKey": "WorldClock"
      },
      {
          "itemKey": "MyTasks"
      },
      {
          "itemKey": "MyRecentFiles"
      },
      {
          "itemKey": "Announcements"
      },
      {
          "itemKey": "ServiceUpdates"
      },
      {
          "itemKey": "MyMailbox"
      },
      {
          "itemKey": "MyEvents"
      }
  ]

Available Command Bar "itemKeys"¶

The following itemKeys are used to display the appropriate apps:

AssociatedSites
AppBar
MyFavourites
WorldClock
MyTasks
MyRecentFiles
Announcements
ServiceUpdates
MyMailbox
MyEvents

The apps you specify using the above structure will appear in the order specified.

Tickers¶

The Announcements and Service Updates components support the ability to display a snippet of an item inline with Command Bar items.

Configuring a ticker for Announcements or Service Updates can be found in the Admin Command.

Ticker Configuration Options¶

This table describes the options that are saved to the topbarconfig.json.

Property	Data Type	Description
`categoryFieldName`	string	This is the SharePoint Internal name of the Column that holds the item Category. For Announcements, this will probably be `MercuryAnnouncementsSeverity`.
`categoryColours`	Array	This is an array of objects that describe the value of Category that an item may have, and what colour it should show.
`categoryName`	string	This is the actual value that an item may have as its category.
`colour`	string	This is a CSS colour value to use for the text colour of an item with this category.

Icons¶

The icons used to display commands can be configured to use our Standard selection of icons or a selection of graphical icons provided by us, or custom ones you select.

Standard¶

Our selection of default icons are provided natively by us, powered by Microsoft's Office UI Fabric icon pack, they are not configurable.

Graphical¶

The custom icons for commands can be customised on a per command bases, and only requires you to have the icon you have in mind on your computer or in SharePoint.

When toggled two new options will present themselves

Config Icon Settings

Configure the icon that appears for the settings Command (the one you're reading about now)

Icon Size (px)

Configure the size of the icons that appear in the Command bar. 32px is the default and lowest setting and it goes all the way up to 64px.

Reminder

Only a Mercury admin can change Command Bar settings.

Activate Graphical Icons¶

From the root hub of your intranet site click the edit command bar icon in the top right
Open the "Command Bar design" sub section
Select from the options "Graphical Design"

Replace default graphical icons for commands¶

From the root hub of your intranet site click the edit command bar icon in the top right
Open the "Command Bar Items" sub section
Open the sub-subsection for the Command you want to change the icon for.
Locate the "Icon Settings" section
Click "Override Icon", you will be presented with a File Picker panel.
Use this panel to either select an image from SharePoint, OneDrive, the internet or your computer.
Click the accept button in the bottom right.
Click Save in the bottom left of the config panel, your page may refresh.

Tip

The accept button in the File Picker is theme coloured and its text changes depending on the selection made, it might say "open" or "add file"

Ideal Images¶

The ideal physical size for your images, should be a perfectly square (1:1) image that is scalable. SVGs are preferable but PNGs and high quality JPGs could also be used just fine.

The Default physical size for icons is 32x32 so an image that is this size or larger will work great!

Tip

Make sure any image you do chose is optimized for the web, keep the file size low! learn more about web optimized images