@scania-plugin/banner
v1.1.31
Published
This banner project is for made for Scania, as an external web element.
Downloads
58
Readme
Scania Banner Plugin
Clone the repo from github link here
and cd into the directory.
sudo npm install
Development server
Run ng serve
for a dev server. Navigate to http://localhost:4200/
. The app will automatically reload if you change any of the source files.
Build plugin through Shell script
Run publish.sh
shell script
This will consolidate the angular production generated files to one single javascript file -- so that it can be later imported into any frontend as an external web component (widget).
The file name generated from production build will be scania-banner-plugin.js
.
To insert the widget
- Insert the tag
<scania-banner id="scania-banner"></scania-banner>
at the place where you want the widget to be used. - On the next line add
<script src="linktorepo/scania-banner-plugin.js"></script>
. - In the
js
file, get the web component element bydocument.getElementById('scania-banner')
and give the configurations to set thebannerconfiguration
attribute of this element bysetAttribute('bannerconfiguration', JSON.stringify(webElementConfiguration))
. - Configurations map of
webElementConfiguration
is as follows
webElementConfiguration = {
type: 'action', // can only be 'greeting', 'action', 'warning', 'danger'
isEnabled: true,
label: '<some label>',
content: '<some content>', // optional
imageUrls:'<some-array-of-image-urls>', // optional
maxImagesToShow: '<number-of-image-icons-to-show-in-banner>' // optional
videoUrls: '<:'<some-array-of-url>', // optional
maxVideosToShow: '<number-of-video-icons-to-show-in-banner>' // optional
action: {
text: '<some-action-button-text>',
url: '<url-if needed>' // optional
},
startDateTime: '<startDateTimeStamp>', // optional epoch datetime stamp
endDateTime: '<endDateTimeStamp>', // optional epoch datetime stamp
}
If the current time is between the start time and the end time, only then the banner would be visible.
The banner can be of four types
greeting
information
warning
danger
Based on type
inside configuration, the banner would reflect automatically with approriate colors and icons.