Overview

This article provides access to a TypeScript sample project that demonstrates how to build and extend Forms using the KWIZ Forms API in VSCode.

This is very useful in larger projects that have a lot of API calls, to be able to collaborate & track versions of your project and separate your solution to multiple smaller files that are easier to maintain.

The sample project can be used as a starter template for developing custom form functionality and integrations.

Repository

The sample project is available in the following GitHub repository:

Snapon Forms API Sample (TypeScript Project)

Repository Contents

Based on the repository structure, the project includes:

• TypeScript source files (src) • Project configuration files • Build configuration (tsconfig.json) • Package management files (package.json, package-lock.json) • Sample implementation code for Forms API usage

Notes

• Fork the repository before making changes. • The /types folder should remain unchanged. • Additional files added to the project are included in the build output. Simply add your API files to the src folder.

Deployment

Once you build the project, the output file can either be pasted as-is in the forms API script editor (Read more in Advanced Customizations using Custom Scripts), or by manually uploading the generated JavaScript output to your site::

~site/SiteAssets/kwizcom/modernui/[list guid]_[project-name].js

Additional Information

Refer to the repository README for setup instructions and implementation details.