Releases: creative-connections/Bodylight.js-Components
v2.3.4
- UPDATE version fb465b7
- UPDATE version d74ed09
- FIX bind2a do not unbind, moved to global markdown component when new document is loaded f2fb2cd
- FIX possible bug when changing pages, not completely detached, not removed bindings 8fbff78
- ADD uuid generation when crypto is not supported on older browser, UPDATE quiz control back forward switch tabs e783827
v2.3.3
v2.3.2
- UPDATE version a6bf445
- UPDATE version 9465fb2
- UPDATE dygraph sa nomogram, quizcontrol to show numbers, 66eadaf
- ADD calculator, update markdown book to read hash when attached, fix quiz-summary 7e75f16
- UPDATE quiz, ADD chartjs option to disable xticks 0f81780
- UPDATE control and summary forward, back buttons 7e26fa7
- UPDATE and fix get-state 07ffe4b
- ADD firebase config and get/set state impl b6bf4c4
- ADD firebase config and get set messaage communication via multiple webapp instances 6e07157
v2.2.9
- UPDATE chartjs time to show reference point on xdata event 5095197
- UPDATE remote-value to do 5 attemps of GET before fail, put error message in DOM to show it e5d4b26
- UPDATE without nav only a button is shown 891de9e
- UPDATE version 45fbcde
- UPDATE version e07322f
- ADD smultiple script support for co-simulation 62cff26
v2.2.8
v2.2.7
v2.2.6
v2.2.5
Bodylight.js-Components
Web components of the Bodylight library. For full documentation see https://bodylight.physiome.cz/Bodylight-docs/reference/. Project portal with links to samples at https://bodylight.physiome.cz/
Bodylight.js web components is a suite of custom elements enhancing HTML web documents with
- FMU component able to be execute in browser.
Modelica
model is exported toFMU
using FMI standard and Bodylight FMU Compiler can convert FMU with source codes and solver into WebAssembly script. - Adobe-Animate and Gif-Animate component able to control animation exported from Adobe-Animate or animated GIF and bind them to variables of model simulation.
- ChartJS and DygraphJS components to visualise model variables in different chart types.
- Following Web components standard.
All bodylight web components are registered with a bdl- prefix. Components are defined in source code without the prefix, which may be used to build application internally in an Aurelia framework https://aurelia.io
This repository contains wrapper code for aurelia-bodylight-plugin registering all Aurelia[2] components as standard (framework agnostic) web components [1].
This plugin is part of broader tools to enable in-browser simulation using modern web technologies: Web Assembly, HTML, Javascript (ECMAScript6).
Usage
To build web simulator:
-
You need to export Modelica model into FMU with source codes including source codes for solver (Dymola exports CVODE, OpenModelica 1.14.x exports Euler and 1.16.x is declared to support CVODE export too).
-
Then you need to convert the FMU into WebAssembly - using Bodylight FMU Compiler
-
the exported ZIP contains JS file - to be reffered from
bdl-fmi
component, andmodelDescription.xml
- standard FMU description with variable references. -
optional - export Adobe Animate animation into CreateJS library usable by
bdl-adobe
component. -
use the Bodylight components, This plugin is distributed in 2 different way: 1) as standard web components or 2) as aurelia components.
- 1. Standard web components - distribution recommended to build web simulator using enhanced HTML or Markdown.
- 2. Aurelia web components - recommended for more complex web application
Live demo and tutorial
https://bodylight.physiome.cz/Bodylight-docs/tutorial/#basic.md
1. Standard web components
-
Use
bodylight.bundle.js
from :- from jsdelivr CDN:
<script src="https://cdn.jsdelivr.net/npm/bodylight-components/dist/bodylight.bundle.js"></script>
- OR install bundle by npm:
npm i bodylight-components
- OR download
bodylight.bundle.js
locally and refer it from your<script>
:
<script src="bodylight.bundle.js"></script>
-
Add attribute
aurelia-app="webcomponents"
todiv
orbody
where web components will be located (note web-components are custom elements with prefixbdl-
:
index.html
...
<body aurelia-app="webcomponents">
<bdl-range id="id1" min="40" max="180" default="60" title="Heart rate"></bdl-range>
<bdl-fmi ...></bdl-fmi>
<bdl-chartjs ...></bdl-chartjs>
</body>
- (optional) you may use any of
bdl-markdown-*
components to refer MD documents where you may use Bodylight webcomponents as well.
E.g.doc/index.md
contains main content andsummary.md
contains sidebar with links to other docs.
index.html
...
<body aurelia-app="webcomponents">
<bdl-markdown-book index="doc/index.md" summary="doc/summary.md">
<img src="docs/loading.gif"/>
</bdl-markdown-book>
</body>
doc/index.md
# Introduction
Markdown syntax is interpretted. Syntax highlighting is enabled for source code. KATEX plugin is enabled to allow
basic equation e.g. $$e = m c^2$$
## bodylight web components
Use bodylight web components directly:
<bdl-range id="id1" min="40" max="180" default="60" title="Heart rate"></bdl-range>
<bdl-fmi ...></bdl-fmi>
<bdl-chartjs ...></bdl-chartjs>
summary.md
| EN | [CZ](#doc/index.cs.md&summary=doc/summary.cs.md) |
* [First Page](#doc/index.md)
* [Second Page](#doc/index2.md)
* [Sub page of second page](#doc/index22.md)
Bodylight webcomponents in Moodle
- edit moodle page in HTML - use HTML source, click and then siwtch code - click
- add the bodylight script
<script type="module" src="https://bodylight.physiome.cz/Bodylight.js-Components/bodylight.bundle.js"></script> <div aurelia-app="webcomponents"><br>
- add bodylight component, note that markdown component needs base to be specified
so relative links are rendered correctly inside Moodle.
For resources in github repo usecdn.jsdelivr.net/gh/
which is returning correct MIME Type.This allows FMI scripts and MD content to be loaded correctly.<bdl-markdown src="https://cdn.jsdelivr.net/gh/creative-connections/Bodylight-Scenarios@master/hemodynamics/index.cs.md" base="https://cdn.jsdelivr.net/gh/creative-connections/Bodylight-Scenarios@master/"> bdl-markdown not supported </bdl-markdown>
Bodylight webcomponents in Adobe Captivate
Bodylight Web Components cannot be inserted directly into Adobe Captivate, however, content created in HTML or MD and hosted in some domain can be added
using direct URL as Web Object
. You may use the showmenu=false
URL parameter, e.g.: https://bodylight.physiome.cz/Bodylight-Scenarios/#hemodynamics/hemo2.cs.md&showmenu=false
2. Aurelia web components
We recommend to use aurelia framework to build web application with Bodylight Web components.
Follow Aurelia doc's how to prepare your project and install aurelia-bodylight-plugin
by npm
command-line:
npm i aurelia-bodylight-plugin
In your main.js
file enable the plugin by aurelia.use.plugin(PLATFORM.moduleName('aurelia-bodylight-plugin'))
, so it may look like:
//main.js
import {PLATFORM} from 'aurelia-pal';
export function configure(aurelia) {
aurelia.use
.standardConfiguration()
.plugin(PLATFORM.moduleName('aurelia-bodylight-plugin'))
aurelia.start().then(() => {
aurelia.setRoot(PLATFORM.moduleName('app'));
});
}
Bodylight web components are available in any template, use them without bdl-
prefix:
<template>
<range id="id1" min="40" max="180" default="60" title="Heart rate"></range>
<fmi ...></fmi>
<chartjs ...></chartjs>
...
</template>
Developer's Guide
Download source code
git clone https://github.com/creative-connections/aurelia-bodylight-plugin.git
git clone https://github.com/creative-connections/Bodylight.js-Components.git
To develop
- components sources at
cd aurelia-bodylight-plugin
npm i
au build
- builds the pluginbuild-all.sh
- builds plugin and ../Bodylight.js-Components at once
To test
- Either manually copy
bodylight.bundle.js
to/test
directory - OR
npm run build
- this will copy bundle into/test
dir - THEN serve http from
/test
folder
To publish
npm login
- logs into npmjssudo npm i np -g
- installsnp
tool globallynp
- UI to publishbodylight-components
into npm as package
release notes
- Update adboe timeout to 1s and pdb component and quiz 041f916
- UPDATE sticky position 9ca7466
- UPDATE animation time delay initialization to 3s f175b34
- UPDATE quiz control title next to arrow 0310050
- UPDATE bundle 61c1df6
- ADD quiz-control and quiz update 9a1d4af
- UPDATE quiz design, build target for babel 326f942
- ADD quiz type match b44118c
- UPDATE repo d218945
v2.2.4
Bodylight.js-Components
Web components of the Bodylight library. For full documentation see https://bodylight.physiome.cz/Bodylight-docs/reference/. Project portal with links to samples at https://bodylight.physiome.cz/
Bodylight.js web components is a suite of custom elements enhancing HTML web documents with
- FMU component able to be execute in browser.
Modelica
model is exported toFMU
using FMI standard and Bodylight FMU Compiler can convert FMU with source codes and solver into WebAssembly script. - Adobe-Animate and Gif-Animate component able to control animation exported from Adobe-Animate or animated GIF and bind them to variables of model simulation.
- ChartJS and DygraphJS components to visualise model variables in different chart types.
- Following Web components standard.
All bodylight web components are registered with a bdl- prefix. Components are defined in source code without the prefix, which may be used to build application internally in an Aurelia framework https://aurelia.io
This repository contains wrapper code for aurelia-bodylight-plugin registering all Aurelia[2] components as standard (framework agnostic) web components [1].
This plugin is part of broader tools to enable in-browser simulation using modern web technologies: Web Assembly, HTML, Javascript (ECMAScript6).
Usage
To build web simulator:
-
You need to export Modelica model into FMU with source codes including source codes for solver (Dymola exports CVODE, OpenModelica 1.14.x exports Euler and 1.16.x is declared to support CVODE export too).
-
Then you need to convert the FMU into WebAssembly - using Bodylight FMU Compiler
-
the exported ZIP contains JS file - to be reffered from
bdl-fmi
component, andmodelDescription.xml
- standard FMU description with variable references. -
optional - export Adobe Animate animation into CreateJS library usable by
bdl-adobe
component. -
use the Bodylight components, This plugin is distributed in 2 different way: 1) as standard web components or 2) as aurelia components.
- 1. Standard web components - distribution recommended to build web simulator using enhanced HTML or Markdown.
- 2. Aurelia web components - recommended for more complex web application
Live demo and tutorial
https://bodylight.physiome.cz/Bodylight-docs/tutorial/#basic.md
1. Standard web components
-
Use
bodylight.bundle.js
from :- from jsdelivr CDN:
<script src="https://cdn.jsdelivr.net/npm/bodylight-components/dist/bodylight.bundle.js"></script>
- OR install bundle by npm:
npm i bodylight-components
- OR download
bodylight.bundle.js
locally and refer it from your<script>
:
<script src="bodylight.bundle.js"></script>
-
Add attribute
aurelia-app="webcomponents"
todiv
orbody
where web components will be located (note web-components are custom elements with prefixbdl-
:
index.html
...
<body aurelia-app="webcomponents">
<bdl-range id="id1" min="40" max="180" default="60" title="Heart rate"></bdl-range>
<bdl-fmi ...></bdl-fmi>
<bdl-chartjs ...></bdl-chartjs>
</body>
- (optional) you may use any of
bdl-markdown-*
components to refer MD documents where you may use Bodylight webcomponents as well.
E.g.doc/index.md
contains main content andsummary.md
contains sidebar with links to other docs.
index.html
...
<body aurelia-app="webcomponents">
<bdl-markdown-book index="doc/index.md" summary="doc/summary.md">
<img src="docs/loading.gif"/>
</bdl-markdown-book>
</body>
doc/index.md
# Introduction
Markdown syntax is interpretted. Syntax highlighting is enabled for source code. KATEX plugin is enabled to allow
basic equation e.g. $$e = m c^2$$
## bodylight web components
Use bodylight web components directly:
<bdl-range id="id1" min="40" max="180" default="60" title="Heart rate"></bdl-range>
<bdl-fmi ...></bdl-fmi>
<bdl-chartjs ...></bdl-chartjs>
summary.md
| EN | [CZ](#doc/index.cs.md&summary=doc/summary.cs.md) |
* [First Page](#doc/index.md)
* [Second Page](#doc/index2.md)
* [Sub page of second page](#doc/index22.md)
Bodylight webcomponents in Moodle
- edit moodle page in HTML - use HTML source, click and then siwtch code - click
- add the bodylight script
<script type="module" src="https://bodylight.physiome.cz/Bodylight.js-Components/bodylight.bundle.js"></script> <div aurelia-app="webcomponents"><br>
- add bodylight component, note that markdown component needs base to be specified
so relative links are rendered correctly inside Moodle.
For resources in github repo usecdn.jsdelivr.net/gh/
which is returning correct MIME Type.This allows FMI scripts and MD content to be loaded correctly.<bdl-markdown src="https://cdn.jsdelivr.net/gh/creative-connections/Bodylight-Scenarios@master/hemodynamics/index.cs.md" base="https://cdn.jsdelivr.net/gh/creative-connections/Bodylight-Scenarios@master/"> bdl-markdown not supported </bdl-markdown>
Bodylight webcomponents in Adobe Captivate
Bodylight Web Components cannot be inserted directly into Adobe Captivate, however, content created in HTML or MD and hosted in some domain can be added
using direct URL as Web Object
. You may use the showmenu=false
URL parameter, e.g.: https://bodylight.physiome.cz/Bodylight-Scenarios/#hemodynamics/hemo2.cs.md&showmenu=false
2. Aurelia web components
We recommend to use aurelia framework to build web application with Bodylight Web components.
Follow Aurelia doc's how to prepare your project and install aurelia-bodylight-plugin
by npm
command-line:
npm i aurelia-bodylight-plugin
In your main.js
file enable the plugin by aurelia.use.plugin(PLATFORM.moduleName('aurelia-bodylight-plugin'))
, so it may look like:
//main.js
import {PLATFORM} from 'aurelia-pal';
export function configure(aurelia) {
aurelia.use
.standardConfiguration()
.plugin(PLATFORM.moduleName('aurelia-bodylight-plugin'))
aurelia.start().then(() => {
aurelia.setRoot(PLATFORM.moduleName('app'));
});
}
Bodylight web components are available in any template, use them without bdl-
prefix:
<template>
<range id="id1" min="40" max="180" default="60" title="Heart rate"></range>
<fmi ...></fmi>
<chartjs ...></chartjs>
...
</template>
Developer's Guide
Download source code
git clone https://github.com/creative-connections/aurelia-bodylight-plugin.git
git clone https://github.com/creative-connections/Bodylight.js-Components.git
To develop
- components sources at
cd aurelia-bodylight-plugin
npm i
au build
- builds the pluginbuild-all.sh
- builds plugin and ../Bodylight.js-Components at once
To test
- Either manually copy
bodylight.bundle.js
to/test
directory - OR
npm run build
- this will copy bundle into/test
dir - THEN serve http from
/test
folder
To publish
npm login
- logs into npmjssudo npm i np -g
- installsnp
tool globallynp
- UI to publishbodylight-components
into npm as package
release notes
- Update adboe timeout to 1s and pdb component and quiz 041f916
- UPDATE sticky position 9ca7466
- UPDATE animation time delay initialization to 3s f175b34
- UPDATE quiz control title next to arrow 0310050
- UPDATE bundle 61c1df6
- ADD quiz-control and quiz update 9a1d4af
- UPDATE quiz design, build target for babel 326f942
- ADD quiz type match b44118c
- UPDATE repo d218945
v2.2.3
- UPDATE version d4c63dc