Package Exports

@m-filescorporation/uix-extensions
@m-filescorporation/uix-extensions/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@m-filescorporation/uix-extensions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

M-Files UI Extensibility Framework

A TypeScript type definitions package for the M-Files User Interface Extensibility Framework (UIX). 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

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

// Entry point for the ShellUI module
function OnNewShellUI(shellUI: IShellUI): void {
  // Register for the NewShellFrame event
  shellUI.Events.Register(MFiles.Event.NewShellFrame, (shellFrame: IShellFrame) => {
    // Register for the Started event
    shellFrame.Events.Register(MFiles.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 as any).OnNewShellUI = OnNewShellUI;

More Information

For more information on M-Files UIXv2 development: