Show:

Users status Class

Defined in: platform/plugins/Users/web/js/tools/status.js:10
Module: Users-tools

Renders a user status area which displays logged in status and provides various user-related operations.

Constructor

Users status

(
  • [options]
)

Defined in platform/plugins/Users/web/js/tools/status.js:10

Parameters:

  • [options] Object optional

    this object contains function parameters

    • [icon] String optional

      Icon for the login button. Defaults to Qbix icon.

    • [label] String optional

      Text for the login button. Defaults to 'log in'.

    • [fullName] Boolean optional

      If set to true, then full name of the user will be displayed, otherwise only the first name.

    • [logoutIcon] String optional

      Url to and Icon for 'Log out' item in the tool menu.

    • [menuItems] Array optional

      Additional menu items besides 'Log out' which will be shown in the user menu. Should be an array of hashes like { 'contents': 'value', 'action': 'value' }

    • [onMenuSelect] Function | String | Q.Event optional

      Function, string function name or Q.Event. Called when user selected some item from user selected some item from user menu except 'Log out'.

Item Index