The FAL-Lite application is built to be intuitive and easily accessible. You may install the application on your site with two lines of code.
Place these two lines of HTML into your page:
<fal-saas configurationurl="__CshSpaDeployUrl__customizations/vmfh/configuration.json" baseurl="/" enable-fal-lite="true"></fal-saas>
<script src="__CshSpaDeployUrl__fal-saas.js" async></script>
The first line of code is a custom element that governs where the FAL-lite will appear on the host page.
The tag name,
fal-saas
, must remain constant and should not be changed.
The second line of code is an unblocking JavaScript tag that instructs the browser to download the core Fal-lite application script.
The
src
attribute on thescript
tag should not be altered; doing so may prevent the application from loading entirely.
Finally, please note that the order of the elements is important and that the custom element should always come before the script tag.
For full working examples of the application, refer to the Example Applications
section here.
The Fal-Saas
element has one attribute, configurationurl
, which points to a JSON configuration file. This configuration file can be hosted by you, the consumer, or be hosted externally, so long as it is accessible to the application at runtime. Exposing a configuration file in this way enables consumers to optionally customize the behavior of the Fal-lite application, assuming the default settings do not meet their requirements.
To find out more about what configurations are available and how to maintain your own configuration file, please see Configuration
base-url
(or baseUrl
)This attribute allows the consuming platform to set the base URL that the Fal-lite Angular application will use to perform its internal routing.
The
base-url
attribute value of"/"
depicted above is an example base URL value and would be the correct value if the host page were located at, say, https://www.example.com/. In other words, this attribute should be set according to where the host page lives.
Including this attribute is optional. If omitted, the application will default to using the value in the href
attribute of the <base>
tag in the <head>
tag of the host page. If the <base>
is also omitted, the application defaults the base URL to "/"
(the root of the current URL).
enable-fal-lite
This is a boolean attribute and this will be set as true
to enable the fal-lite rendering. if we set as false
or omitted Find a Location will be rendered.