WaveMaker Docs

WaveMaker Docs

  • Get started
  • Widgets
  • Mobile
  • How-to
  • Enterprise
  • Releases
  • Blog
  • Sign-in

›Prefabs

How-to-documents

  • How-to Wiki
  • WaveMaker Best Practices

App solution

  • Creating a Registration Page
  • Support for Password Encryption
  • Error Handling in WaveMaker App
  • Leaving Page with Unsaved Changes
  • Micro frontend using iframes
  • Enabling PWA

UI design

  • Passing Parameters to Pages
  • Passing Parameters to Partial Page
  • Accessing Script
  • Use Static Variable to pass data between pages
  • Customise Login Page
  • Incorporating Additional Icons
  • Change Icon Color on Condition
  • Change Icon for the Global Spinner
  • Changing Default Favicon
  • Changing App Logo
  • Changing Page Title
  • Customise App Style
  • How to use Conditional Class Property
  • How to use Conditional Style Property
  • Customize an Existing Theme
  • Adjust Left Navigation Width
  • Customizing Theme
  • Enable SPA
  • Choose Widget Template and Layout
  • Widget Template and Icons
  • Custom Template for Widgets
  • Apply Custom Data Formatter

Nav & Dropdown

  • Dynamic Menu based on User Role
  • Restricting Menu Items based on the User Role
  • Localization for Dropdown Menu

Localization

  • Localization in WaveMaker Apps
  • Setting Language and Date Format
  • Localization Using Select Locale
  • Localization of Error Messages

Security

  • SAML Integration - OneLogin
  • SAML Integration - ADFS
  • OpenID Integration - Azure AD
  • Custom Security using Google OAuth Prefab
  • Multiple Security Provider Implementation
  • Customizing Post Authentication Handlers
  • Configuring Content-Security-Policy
  • Configuring MTLS

Databases

  • Queries with Dynamic Where Clause
  • Connect To Azure SQL Server
  • Recommended JDBC Driver Versions for Databases
  • How to fetch more than the default number(100) of records from database?
  • How To: One-to-Many Relationship
  • Working with Temporals
  • Connect To AWS Redshift Database
  • Connect To SAP Hana Cloud Database
  • Transactional History of Entity
  • Row-Level Security using DB Event Listeners
  • Validations using CRUD Listeners
  • Custom Logic DB Event Listeners
  • Connect to MySQL database using SSL
  • How to Switch MariaDB to MySQL Connector

Web services

  • Using App Environment Properties
  • Consuming an Existing WaveMaker API
  • Using POST method to send data to a REST API
  • Request-Response Processing for REST Services
  • How to Intercept Request and Response of all API Calls in One Place
  • WebSocket Usage - Chatroom App
  • UI for API Server-side Pagination
  • Working with API with different pagination formats

Java services

  • Sending Email using WaveMaker Connector
  • Implementing Forgot Password feature using Java Service
  • Accessing REST APIs from Java Service
  • Scheduling a Java Service
  • Integrating JUnit Tests for WaveMaker Application
  • ORM Artifacts
  • Pre-Post Processing for Database Service APIs
  • Accessing Logged-in User Details using Java Service
  • Design a workflow in Camunda BPM and integrate into a WaveMaker app
  • Integrate Azure File Storage
  • Insert Data from Excel into Database
  • Integrate Amazon S3 into WaveMaker App
  • Integrate Twilio Connector
  • Integrate OTP (One-Time Passcode) Verification with WaveMaker App

Variables

  • Using Filter Conditions on Variable
  • Using Live Variable APIs
  • Using Notification Actions
  • Using Navigation Action
  • Using Variables for Queries and Procedure
  • Using Service Variable in a Form
  • Using Filter Criteria for a Data and Live Widgets
  • Using Filter Criteria for a Database CRUD Variable

JavaScript

  • Using JavaScript in Binding
  • Using JavaScript from External URL
  • Using JavaScript to loop a command
  • Using function for evaluating conditions

Developer options

  • Synchronizing WaveMaker Apps with IDEs
  • Synchronizing Java Services Controller
  • Integrating Amazon Cognito for User Authentication
  • Integrating Sample Jasper Report in WaveMaker Application
  • How to generate PDF File using Jasper Reports
  • Upgrading an App from WaveMaker 9.x to WaveMaker 10.0
  • App Migration from WaveMaker 9x to 10x
  • Setup Fusion Reactor for Debugging Issues

Deployment

  • SSL Termination in LoadBalancer

Mobile App Solutions

  • Notify users about new update

Mobile gesture

  • Setting Swipe Gestures on a List Widget
  • Working with Pull to Refresh

Mobile widgets

  • Using Search Widget within the Navbar

Mobile UI design

  • Setting Splashscreen Images and App Icons
  • Using Cordova Plugins
  • Designing Tablet Views in Mobile Project
  • Sliding left navigation for Mobile App
  • Mobile App using Bar code
  • Custom Date Picker in Mobile

Cards

  • Capturing Card Items

DataTable

  • Customising Data Table Row Action
  • How to Configure Row Expansion in a Data Table
  • Using Widgets to represent Data Table Columns
  • View Master-Detail Data Records using Data Table
  • Add Master-Detail records using Data Table
  • Export Data from Data Table
  • Export Data from Data Table - 2
  • Setting Blob Filename
  • Dynamic Data Tables
  • Customize Dynamic Datatable
  • Data Table Column bound to Query
  • Combining Columns in Data Table
  • Custom Styling Data Table Columns & Rows
  • Formatting Data Table Columns
  • Concurrency and Record Locking in WaveMaker
  • Edit DataTable records bound to Query API

List

  • Creating an Employee List grouped by City
  • Creating an Employee List grouped by Birth Month and City
  • OnRender Event
  • Including a Data Table within a List
  • Building an Editable List
  • Building Cascading Lists
  • Accessing List Items
  • Localization of Data Table Column Headings

Forms

  • Using Live Form
  • How Tos: Form
  • Building Tabbed Live Form
  • How Tos: Live Form
  • Linking Live Form with another Widget for Input
  • Handling Related Fields in a Live Form
  • How to Get Validation Messages from a Form
  • Adding Master-Detail records in the same transaction
  • Submit Parent and Child Records in a Single Transaction
  • Submit Parent and Child Records in a Single Transaction using Form and Data Table
  • Using Cascading Select & Autocomplete for Live Form Fields
  • Using Cascading Select within Live Form
  • Using cascading Filter to populate Live Form
  • Using Wizard for Master-Detail Live Form
  • Copy to Clipboard
  • Create a form with multiple wizard steps
  • Smart Forms: Conditional Flows for form Widget

Calendar

  • How Tos: Calendar
  • Calendar Usage - Create an Event
  • Calender Usage - Google Calendar Integration

CheckboxSet

  • CheckboxSet to Filter List data

FileUpload

  • FileUpload - Basic Usage
  • File Upload Widget Operations
  • Upload File & Save in Database
  • File Upload & Blob Data
  • File Upload - Custom Directory
  • Accessing File Upload from Java Code
  • Upload Files from Live Form & Form

Radioset

  • Radioset to Filter a List

Rating

  • Building Rating Widget using Static Data
  • Building Rating Widget using Static Variable
  • Build Rating Widget using Model Variable
  • Building an Interactive Rating Widget

Select

  • Configuring Select Widget from a Static List of Values
  • Configuring Select Widget from a Static Variable
  • Configuring Select Widget from a Variable
  • Configuring Select Widget using Display and Data Fields
  • Configuring Select Widget from Database Fields
  • Configuring Cascading Select
  • Selection Widgets - Use Case

Progress Circle

  • Using Progress Circle Widget

Charts

  • Working with Charts
  • Display User Selection in another Widget
  • Handling Dynamic Data
  • Custom Data

Richtext Editor

  • Adding Custom Fonts to Richtext Editor

Live filter

  • Applying Live Filter to a Data Table or a Chart
  • Building a Multiple Selection Live Filter
  • Building a Range Live Filter

Container

  • Setting partial page content for Accordion within a List
  • Setting partial page content for Panel within a List using JavaScript
  • How Tos: Wizard
  • Dynamic Tabs and Accordions

Tree

  • Tree using Static Variable
  • Tree using Java Service
  • Tree using Dynamic Tree

Prefabs

  • Creating Partials in a Prefab
  • Create Prefab using Third Party UI Widgets
  • Create a Simple Prefab
  • Create Prefab Using D3 & NVD3 Charts
  • Create Prefab Using D3 Library DataMaps
  • Create Prefab using JQuery Plugin
  • Create Prefab using Angular Module
  • Create Prefab using Angular, React Components
  • Azure OAuth Prefab Integration

Team Poral Configure Vcs

  • Configure Azure Repos In CodeRepository
Edit

Create Prefab using Angular, React Components


WaveMaker framework is a pure javascript based runtime, making it compatible with most of the open web standards. The developers can include jquery based ui plugins, visualization libraries or any other javascript based code units to extend or complement the rich component library provided by the WaveMaker framework.

The components developed in one of the js frameworks are normally not compatible with other frameworks and cannot be directly used inside standard HTML markup with framework or build bundles. Inorder to make these components work across web, it needs to be converted into a framework agnostic module. Web Components is one of such open standards. It relies on standard browser APIs such as CustomElements, Shadow DOM enabling its support across browsers & frameworks. As mentioned earlier, WaveMaker works greatly with Open Standards thus with Web Component/Custom Elements as well.

Most of the modern javascript frameworks have support for packaging the components as Web Components. WaveMaker supports the use of Web Components inside its projects & recommends its integration through Prefabs. Its recommended to refer documentation to know more about Prefabs in detail.

The developers with Angular or React based components can leverage them in the WaveMaker project by exporting them as Web Components & importing through Prefabs.This documentation helps you understand the process with the help of Sample Component(PosterWidget) developed in both React & Angular. The source code is also shared for reference.

note

The shared PosterWidget uses OMDB API to fetch resources. If you are planning to try out the source code of component, please get the API key & replace in the source code before build.

Convert Angular Component into Prefabs

Angular Framework recommends Angular Elements to export its components as Web Componenets. The documentation covers the process in detail with sample code as well.

Sample Angular Component

For this demonstration we will use a PosterWidget Component developed with Angular version 9. The code for the component can be found in the Github repository. The repo has the Angular elements configured for the project. So, on building it generates Web Component artefacts for the PosterWidget angular component.

However, you can download the artefacts directly from here & continue with the rest of the steps. The artefact is a zip file & on extracting it provides following files,

  • polyfills-*.js
  • vendor-*.js
  • runtime-*.js
  • styles-*.js
  • main-*.js
note

Before importing the Angular based Web Component into WaveMaker Prefabs/Projects, please validate that the components have no render issues or errors by including them in an plain HTML files.

Create Prefab

Once we have the artefacts, we can create a Prefab for it with the help of below steps,

  • Create a Prefab project using the Prefab tab of the Project Dashboard.

  • Enter a Name and Description for the Prefab

  • Upload the artefacts into the Resources folder of project as shown below.

  • From the Project Screen, choose Config Prefab under Settings. In the Resources tab, update Scripts with the JS file imported in the previous step.

  • Please ensure the Javascript sction the scripts in the below order
    • polyfills-*.js
    • vendor-*.js
    • runtime-*.js
    • styles-*.js
    • main-*.js
  • Open the index.html of the Prefab project and add the below Web Component polyfills to ensure support for all the browsers
...
<head>
    ...
    <!-- WebComponent Polyfills -->
    <script src="https://unpkg.com/@webcomponents/webcomponentsjs/webcomponents-bundle.js"></script>
    <script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.2/custom-elements-es5-adapter.js"></script>
</head>

...
  • Open the markup of Main page of Prefab and add the below code to use poster-widget-angular Web Component in the page markup.
<!-- PREFAB MARKUP -->
<wm-prefab-container name="prefab_container1">
    <div style="height:200px; width:200px">
        <!-- 
        Initialize the webComponent with attributes either in the markup & in the script, 
        The OnPropertyChange can be used to bind the value to attributes
        -->
        <poster-widget-angular title="" html-custom-element="true"></poster-widget-angular>
    </div>
</wm-prefab-container>
  • Inorder to specify poster-widget-angular is a Web Component & not built in components, please add an additional attribute html-custom-element="true".
  • Click on Preview, to check if the Web component is rendered without any issues.

  • Once the component is rendered, we need to configure the input attribute title for the component.
  • Inorder to communicate with web components, Prefab has an option called Properties under Prefab Configurations as shown below.
  • Add a new property named title using the interface as shown below.

  • This property can be used as a bridge between the external inputs or bindings to dynamically update the attribute of the WebComponent.
  • Once the property is added, we can write the script to update the Web Component's attribute on change of the property as shown below.
// PREFAB SCRIPT CODE
...

Prefab.onPropertyChange = function(key, newVal, oldVal) {

    switch (key) {
        case 'title':
            /* Get the container Id */
            let widget_id = Prefab.Widgets.prefab_container1.widgetId;
            /* 
            Get the WebComponent instance & 
            update the new property value to its "title" attribute
            */
            document.querySelector('div[widget-id="' + widget_id + '"]')
                .querySelector('poster-widget-angular')
                .setAttribute('title', newVal);

            break;
    }

};

...

  • Now test the Prefab using Preview option again. Try with updating the title value in Inputs section of Properties. The Web Component should update accordingly.

Publish Prefab

  • Save & Publish the Prefab. You can set the version for the Prefab and Publish it. Know more about publishing Prefabs from here.
  • Once approved, the Prefab will be available for use across the Projects. An entry will appear in the Artefacts list from the Developer Utilities on the Project Workspace. The Prefab needs to be imported before it can be used from the Widget Toolbox.

Convert React Component into Prefab

Unlike Angular, currently there is no official support from React to develop Web Components. However, there are several community backed projects which can help in achieving it. Alternatively, developers can build Custom Element wrapper classes over existing react components as well. Lots of community blogs are available for both approaches which can be referred.

Sample React Component

For this demonstration we will use a PosterWidget Component developed with React Version 17. The sample React component is converted into a Web Component using Custom Element Wrapper approach in which each lifecycle event of React is mapped to corresponding event in CustomElement. The code for the component can be found in the Github repository. The repo has all the details to build & generate Web Component artefacts for the PosterWidget React component.

However, you can download the artefacts directly from here & continue with the rest of the steps. The artefact is a zip file & on extracting it provides following files,

  • react-poster-widget.min.js
  • react-poster-custom-element-wrapper.min.js
note

Before importing the React based Web Component into WaveMaker Prefabs/Projects, please validate that the components have no render issues or errors by including them in an plain HTML files.

Create Prefab

Once we have the artefacts, we can create a Prefab for it with the help of below steps,

  • Create a Prefab project using the Prefab tab of the Project Dashboard.

  • Enter a Name and Description for the Prefab

  • Upload the artefacts into the Resources folder of project as shown below.

  • From the Project Screen, choose Config Prefab under Settings. In the Resources tab, update Scripts with the JS file imported in the previous step. As we are rendering React elements inside out custom element wrapper, we should import React & React DOM libs as well.

  • Please ensure the Javascript sction the scripts in the below order
    • https://unpkg.com/react@17/umd/react.production.min.js
    • https://unpkg.com/react-dom@17/umd/react-dom.production.min.js
    • react-poster-widget.min.js
    • react-poster-custom-element-wrapper.min.js
  • Open the index.html of the Prefab project and add the below Web Component polyfills to ensure support for all the browsers
...
<head>
    ...
    <!-- WebComponent Polyfills -->
    <script src="https://unpkg.com/@webcomponents/webcomponentsjs/webcomponents-bundle.js"></script>
    <script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.2/custom-elements-es5-adapter.js"></script>
</head>

...
  • Open the markup of Main page of Prefab and add the below code to use poster-widget-react Web Component in the page markup.
<!-- PREFAB MARKUP -->
<wm-prefab-container name="prefab_container1">
    <div style="height:200px; width:200px">
        <!-- 
        Initialize the webComponent with attributes either in the markup & in the script, 
        The OnPropertyChange can be used to bind the value to attributes
        -->
        <poster-widget-react title="" html-custom-element="true"></poster-widget-react>
    </div>
</wm-prefab-container>
  • Inorder to specify poster-widget-react is a Web Component & not built in components, please add an additional attribute html-custom-element="true".
  • Click on Preview, to check if the Web component is rendered without any issues.

  • Once the component is rendered, we need to configure the input attribute title for the component.
  • Inorder to communicate with web components, Prefab has an option called Properties under Prefab Configurations as shown below.
  • Add a new property named title using the interface as shown below.

  • This property can be used as a bridge between the external inputs or bindings to dynamically update the attribute of the WebComponent.
  • Once the property is added, we can write the script to update the Web Component's attribute on change of the property as shown below.
// PREFAB SCRIPT CODE
...

Prefab.onPropertyChange = function(key, newVal, oldVal) {

    switch (key) {
        case 'title':
            /* Get the container Id */
            let widget_id = Prefab.Widgets.prefab_container1.widgetId;
            /* 
            Get the WebComponent instance & 
            update the new property value to its "title" attribute
            */
            document.querySelector('div[widget-id="' + widget_id + '"]')
                .querySelector('poster-widget-react')
                .setAttribute('title', newVal);

            break;
    }

};

...

  • Now test the Prefab using Preview option again. Try with updating the title value in Inputs section of Properties. The Web Component should update accordingly.

Publish Prefab

  • Save & Publish the Prefab. You can set the version for the Prefab and Publish it. Know more about publishing Prefabs from here.
  • Once approved, the Prefab will be available for use across the Projects. An entry will appear in the Artefacts list from the Developer Utilities on the Project Workspace. The Prefab needs to be imported before it can be used from the Widget Toolbox.

Using Prefab inside the Project

  • Open/Create a Project to use the Prefabs.
  • Open the index.html of the Project and add the below Web Component polyfills to ensure support for all the browsers
...
<head>
    ...
    <!-- WebComponent Polyfills -->
    <script src="https://unpkg.com/@webcomponents/webcomponentsjs/webcomponents-bundle.js"></script>
    <script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.2/custom-elements-es5-adapter.js"></script>
</head>

...
  • Drag & Drop AngularElementPrefab, ReactElementPrefab (names may vary depending on what users have saved their prefabs with) Prefabs onto the page.

  • Drag & Drop a Select widget into the page, & provide static list of movie title as its Dataset value. We will be binding the selected title as the input for Prefabs.

  • Bind Title property value on the Prefab to value from Select widget.

  • Preview & Deploy the application to validate Prefabs created from Angular & React Components.

See Also

Prefab to compare two strings
Prefab using 3rd Party UI Widgets
Prefab Using D3 & NVD3 Charts
Prefab Using D3 Library (DataMaps)

Last updated on 6/9/2021 by Swetha Kundaram
← Create Prefab using Angular ModuleAzure OAuth Prefab Integration →
  • Convert Angular Component into Prefabs
    • Sample Angular Component
    • Create Prefab
    • Publish Prefab
  • Convert React Component into Prefab
    • Sample React Component
    • Create Prefab
    • Publish Prefab
  • Using Prefab inside the Project
  • See Also
WaveMaker
  • PRICING
  • PARTNERS
  • CUSTOMERS
  • ABOUT US
  • CONTACT US
Terms of Use | Copyright © 2013-2023 WaveMaker, Inc. All rights reserved.