DockStudio · Quick start

From install to first window — 10 minutes

Four commands, one module class — and an app with docks, tabs and menus is up and running.

Steps

Install and run

1

Installing the SDK

npm i -g @blackelephant/dockstudio-cli
2

Creating a project

dockstudio new my-app --template workspace
3

Adding a module

dockstudio add module Documents
4

Running

dockstudio run --watch
DocumentsModule.cs
// A module is described declaratively — the shell builds the UI itself
public class DocumentsModule : DockModule
{
    public override void Initialize(IModuleContext ctx)
    {
        ctx.AddPanel<DocumentListPanel>("Documents", DockArea.Left);
        ctx.AddPanel<DocumentPreviewPanel>("Preview", DockArea.Center);

        ctx.AddCommand("doc.create", "Create document")
           .WithShortcut("Ctrl+N")
           .WithPermission("documents.write")
           .OnExecute(() => ctx.Services.Get<IDocumentService>().Create());
    }
}

Panels, commands and permissions are declared declaratively. The shell places them in the interface and restores the user’s layout on the next launch.

Documentation

What the developer kit includes

API reference

A full description of the core, shell and service interfaces with call examples and common errors.

Project templates

Starters for an app, a module and a plugin: an enterprise workstation app, an engineering tool, a simple viewer.

Debugging tools

A layout inspector, a bus event viewer, a panel profiler and a plugin sandbox.

Learning materials

Step-by-step guides, an SDK video course and walkthroughs of common architectural decisions.

Design kit

Theme tokens, an icon pack, interface density rules and ready-made control styles.

Build and delivery

CI scripts, build signing, installers and an auto-update mechanism for your users.

Video

Tutorial videos

This section is being filled with SDK walkthrough recordings. For now, here is the outline of the upcoming course.

12:30 Coming soon
Development

A module from scratch

From a project template to a working panel in the main window.

7:15 Coming soon
Interface

Workspace layouts

Saving, exporting and distributing layouts to users.

9:40 Coming soon
Appearance

Themes and branding

Restyling the application to match the customer's brand.

All DockStudio videos

Need access to the SDK?

We’ll send the distribution, the documentation and a Community edition key, and run introductory training if needed.