Skip to content
Kunkun
Guides API Docs Blog Releases

Template UI

Template (Web Worker) Extensions

Docs: https://docs.api.kunkun.sh/interfaces/ui.IUiWorker

A template extension scaffold can be created with the following command:

Terminal window
npm init kunkun@latest

Read the extensions section first to learn more about this kind of extension.

ui API provides the following methods:

  • showLoadingBar
    • Display a loading bar at the top of the page
    ui.showLoadingBar(true);  // show loading bar
    ui.showLoadingBar(false); // hide loading bar
  • setScrollLoading
    • Display a loading spinner when the user scrolls to the bottom of list view
  • setSearchTerm
    • Set the search term in the search bar
  • setSearchBarPlaceholder
    • Set the placeholder text in the search bar
  • render
    • Render a extension based on template, (e.g. list view, form view, etc.)

I will explain how to use the ui API to build a template extension.

Sample code can be found in the extensions section.