Generate Akumina widget packages using NPM - akumina/AkuminaTraining GitHub Wiki

Overview

Akumina widget development uses HTML and JavaScript to create a client side component, called a widget, that is rendered inside an Akumina site. The akumina-widget-builder NPM package speeds the creation and packaging of custom Akumina widgets, allowing faster development cycles.

See also: Building-a Custom Widget: Overview

Initialization

To make the akumina-widget-builder available from the command line:

npm install -g akumina-widget-builder

Usage

To use the akumina-widget-builder to create a widget stub:

akumina-widget-builder stub Akumina.Extensions.HelloWorldWidget

This will generate a stub wigdet with the following resources:

  • config - The widget's configuration file.
  • js - The JavaScript or TypeScript file for the widget class.
  • views - The html view for the widget.