NPM Libraries

For getting started with front-end development for Blueriq applications, we offer NPM libraries that you may use as a basis for a custom theme. At the moment we are releasing the libraries as beta versions, given that we would like to first obtain feedback from real-world theme implementations before considering the API stable enough for a stable release.

@blueriq/core

The core library implements common logic for dealing with Runtime API responses. If you are using TypeScript, you will also have access to interface definitions of the API request/response data.

Features

• Creation of a rich, hierarchical page model of Blueriq page elements
• Easily create page events from the page model
• Handles updating of the page model from event responses
• Includes validation rule implementations for simple field validation rules
• Includes a powerful CSS-like selector engine for both querying and matching of page elements

Releases

The library artifacts contain the source bundles for various language levels, e.g. ES2015, ES5 and as UMD bundle. We recommend you to use a bundler such as Webpack that will use the appropriate bundle.

Known limitations

• Only the Required  and Regexp validation rules are available

Requirements

You must ensure that polyfills for ES2017 features are available at runtime in the browser. To accomplish this, we recommend including core-js in your final Javascript bundle. At least the following polyfills are required: Collections (Map and Set), String, Object, Array,  and Symbol.

@blueriq/angular

The angular library is a fully fledged framework built on top of Angular that provides idiomatic Angular integration.

Features

• Easy starting of Blueriq flows with the <bq-project> component
• Declarative specification of which Angular component is to be used for a given Blueriq element using CSS selectors
• Declarative querying for Blueriq child/descendant elements with certain conditions from within components
• Presentation style to CSS class mapping facilities
• Integration with Angular Reactive Forms
  
  • Validation as you type
• Insight in user activity through Redux actions
• Separate lifecycle from the Runtime, allowing for smaller Runtime migrations
• Compatible with Blueriq 10 and 11
  
  • Supports both the Legacy and V1 API

Releases

Known limitations

• The V2 API implementation is currently missing
• Support for security messages is currently missing
• File upload/download abstractions are currently missing