You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
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.
Repository
In the future, the library packages are meant to be distributed via our Artifactory. Due to firewall limitations however scoped NPM packages (e.g. our own @blueriq/*
packages) fail to be resolved correctly at the moment. In the meantime, packages may be downloaded below such that you may include them in your package.json
file using a file:
location instead of a version number.
@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 definition of the API request/response data.
Features
- Creation of a rich, hierarchical page model of Blueriq page elements
- Handles page model updates 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
Version | Download |
---|---|
0.3.0-beta.1 | blueriq-angular0.3.0-beta.1.tgz |
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
- Integration with Angular Reactive Forms
Releases
Version | Download | Comments |
---|---|---|
0.3.0-beta.1 | blueriq-core-0.3.0-beta.1.tgz | For Angular ^5.2 and ^6.0 |
Known limitations
- The V2 API is currently missing
- Support for security messages is currently missing