aurelia-elm
v1.0.0
Published
An aurelia plugin to emded Elm apps inside aurelia
Downloads
3
Readme
Aurelia elm
A plugin to embed elm apps inside aurelia
This plugins's insipiration were the taken from react-elm-components and ng-elm elm counterparts
Install
npm install aurelia-elm --save
Use
export async function configure(aurelia) {
//...
aurelia.use
//..
.plugin('aurelia-elm')
}
<!-- in your view -->
<aurelia-elm
src.bind="elmApp">
</aurelia-elm>
//in your view-model
import { HelloWorld } from './elm-app.js';
export class MyViewModel {
constructor() {
this.elmApp = HelloWorld;
}
}
Bindable props
src
- The compiled elm module that you imported.flags
- If your elm app has flags pass them hereports
- callback function called to handle the app's ports
More about interop elm
Read this https://guide.elm-lang.org/interop/javascript.html
Building The Code
To build the code, follow these steps.
- Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
- From the project folder, execute the following command:
npm install
- Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
- To build the code, you can now run:
gulp build
You will find the compiled code in the
dist
folder, available in three module formats: AMD, CommonJS and ES6.See
gulpfile.js
for other tasks related to generating the docs and linting.
Running The Tests
To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
- Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
- Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
- Install the client-side dependencies with jspm:
jspm install
- You can now run the tests with this command:
karma start