Skip to content
This repository was archived by the owner on May 17, 2021. It is now read-only.

mongodb-js/compass-status

Repository files navigation

Compass Status

Compass Status Plugin

Usage

Trigger specific actions:

  var StatusAction = app.appRegistry.getAction('Status.Actions');

  // Can call individual actions
  StatusAction.showAnimation();
  StatusAction.setMessage('Loading navigation');

  // Can configure many things at once
  StatusAction.configure({
    animation: true,
    message: 'Loading Databases',
    visible: true
  });

See a subview

For example, the schema subview:

  var StatusAction = app.appRegistry.getAction('Status.Actions');
  var SchemaStatusSubview = app.appRegistry.getComponent('Schema.StatusSubview');
  var SchemaStore = app.appRegistry.getStore('Schema.Store');
  StatusAction.showAnimation();
  StatusAction.setSubview(SchemaStatusSubview);
  SchemaStore.setState({samplingState: 'timeout'});

  // Also possible to show the waiting state
  SchemaStore.setState({samplingState: 'error', samplingTimeMS: 15001});

Roles

Key Description
Application.Status The status plugin component

Actions

Key Description
Status.Actions Gets all the status actions.

Stores

Key Description
Status.Store Triggers with status information.

License

Apache 2.0

About

Compass Status Plugin (Bar and Animated Overlay)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5