M-Files UI Extensibility Framework

A TypeScript type definitions package for the M-Files User Interface Extensibility Framework. This package provides types to develop client-side applications that extend the M-Files client interface, supporting features like custom commands, dashboards, and event handling.

Installation

Install the package via npm:

npm install @m-filescorporation/uix-extensions

Usage

ShellUI module

See more information about the modules and how to use the ShellUI module for example to create new commands and open new Dashboards.

import {
  IShellUI,
  IShellFrame,
  Event,
} from "@m-filescorporation/uix-extensions";

// Entry point for the ShellUI module
function OnNewShellUI(shellUI: IShellUI): void {
  // Register for the NewShellFrame event
  shellUI.Events.Register(Event.NewShellFrame, (shellFrame: IShellFrame) => {
    // Register for the Started event
    shellFrame.Events.Register(Event.Started, () => {
      // Show a message when the ShellFrame is ready
      shellFrame.ShowMessage("ShellFrame is available for use.");
    });
  });
}

// Bind to global scope (required for UIX)
window.OnNewShellUI = OnNewShellUI;

Dashboard Module

Dashboards are standalone web applications running inside the M-Files UI. The can access the features of the M-Files Host application using the UIXv2 framework.

See more information about the dashboards.

import {
  IDashboard,
  Event
} from "@m-filescorporation/uix-extensions";

function OnNewDasboard(dashboard: IDashboard): void {

    // Register for changes of the CustomData for the Dashboard
    dashboard.Events.Register(Event.CustomDataChanged, (data) => {
        // Render new data based on newly arrived data
    });
}

More Information

For more information on M-Files UIXv2 development:

• M-Files Developer Portal
• User Interface Extensibility Framework