Angular integration module for Jexia Javascript SDK
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
.github
example
libs/ng-jexia
tools
.editorconfig
.gitignore
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
angular.json
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

NgJexia

CircleCI

The official library to use Jexia with Angular

Install

Install this package along with Jexia JavaScript JDK:

npm install ng-jexia jexia-sdk-js --save

Quick Start

Open app.module.ts, import the Jexia module and specify your dataset configuration:

import { NgJexiaModule, DataOperationsModule } from 'ng-jexia';

@NgModule({
  imports: [
    BrowserModule,
    NgJexiaModule.initialize({
      ...environment.jexiaConfig,
      providers: [
        DataOperationsModule,
      ],
    })
  ],
  declarations: [ AppComponent ],
  bootstrap: [ AppComponent ]
})
export class AppModule {}

Use our service to access and manipulate your datasets.

import { Component } from '@angular/core';
import { DataOperations } from 'ng-jexia';

@Component({
  selector: 'app-root',
  templateUrl: 'app.component.html',
  styleUrls: ['app.component.css']
})
export class AppComponent {

  userDataset = this.dataOperations.dataset<User>('myusers');
  users = this.userDataset.select().execute();

  constructor(
    private dataOperations: DataOperations,
  ) {}
}

Then use it on your template:

<pre>
  data: {{ data | async | json }}
</pre>

Developer Guide

Example app

You can find runnable the code at this repository on apps/example, use your own credentials at the app.module.ts, and run the whole application it with npm start command at the root of this project.

Api Docs

Check out the ng-jexia docs and the JavaScript SDK Docs for a detailed view of the Api of both this Angular adapter and the original JavaScript SDK.

Contributing

You can find all the steps at the Contributing Guide.

License

MIT