LobsterInk.UIStandard

Overview

Standard components, directives, services, and other re-usable code for Lobster Ink applications

Components

• The LobsterComponentsModule includes all re-usable components, like the file uploader and markdown editor

Directives

• The LobsterDirectivesModule includes the re-usable directives for access and dragging
• Subscriber and DebugLogger can be imported separately, so app components can extend them

Forms

• Validators includes basic validator functions - app-specific validation should be handled in the app
• The createFormGroup helper function sets up an Angular form

Infrastructure

• The Action and Update Channels provide message bus functionality
• There are a range of services. e.g. access control, theming

Listings

• The Listings class provides static methods to simplify listing page functionality
• There are also some standard enums for listings

Mocks

• Mocks for Angulars ActivatedRoute, NgControl, and PlatformLocation to facilitate karma testing

Pipes

• The LobsterPipesModule includes a range of utility pipes

Styles

• The atoms of the Lobster atomic design are included here, with variables and some helpfull mixins

Utils

• The various Utility classes provide functionality relating to date and time, working with enums, routing, and so on.
• Miscellaneous functionality that does not fit in any other category is found in 'LobsterUtils'

Working on the plugin

Getting started

Run npm install to bring in the dependencies

Running the tests

Run npm test

Deploying a new version of the plugin

• Increment the version number in package.json
• npm run compile
• npm test
• npm publish