Extension Action

Summary

Extension Actions are built-in UI methods for communicating with users from your extension. They include displaying modal messages, banner notifications, and closing the extension.

Overview

  • Show modal messages (success, error, info, warning)
  • Show non-blocking banner notifications
  • Close the extension with closeExtension()

Sub-Sections

Comparison: Show Message vs. Show Banner Message

FeatureShow MessageShow Banner Message
TypeModal dialogBanner notification
BlockingYes (requires user action)No (non-blocking)
ButtonsOptional custom buttonsNo buttons
Best ForConfirmations, errors requiring acknowledgmentStatus updates, progress notifications
APISigmaSDK.WRITER.showMessage()SigmaSDK.WRITER.showBannerMessage()

Message Types

Both methods support four message types:

  • "success" — Operation completed successfully
  • "error" — An error occurred
  • "info" — Informational message
  • "warning" — Caution or advisory message

Close Extension

To programmatically close the extension panel:

SigmaSDK.WRITER.closeExtension();

Quick Examples

Modal Message

SigmaSDK.WRITER.showMessage({
    type: "success",
    title: "Done!",
    message: "Your data was saved successfully."
});

Banner Notification

SigmaSDK.WRITER.showBannerMessage({
    type: "info",
    message: "Processing your request..."
});

Related Pages