Skip to main content

Experience App SDK

||

Showpad Apps are built using the Experience App SDK. This is a TypeScript library to help you use ShowpadJS, the JavaScript library injected on the window where your Showpad App is running. It acts as a bridge between your app and native Showpad functionality across platforms, providing:

  • support for local development
  • a modern typed interface
  • and more

During development of your Showpad App, you'll use the Experience App SDK to communicate with the SDK API.

What you'll learn:

  • How to install the Experience App SDK with npm or yarn
  • How to import the SDK into your extension code
  • File path considerations when your app runs inside an iframe
TL;DR
  • Install: npm install @showpad/experience-app-sdk
  • Import: import { Showpad } from '@showpad/experience-app-sdk'
  • Full API reference: SDK API Reference

Platform and Browser Compatibility​

The Experience App SDK is exclusively distributed as an ES6 Module (ESM). This modern approach allows you to import the objects as needed and is recommended for compatibility with newer browser versions.

Retrieving the Library​

Install the library at the root of your project using npm or Yarn. Node.js must be installed on your system.

npm install @showpad/experience-app-sdk

Then you can import the library:

import { Showpad } from '@showpad/experience-app-sdk';

Special Considerations​

Filepaths​

Showpad Apps are displayed in Iframes. Absolute paths may not resolve correctly when importing files or routing within your app. Use relative paths instead.

Next Steps​

Was this page helpful?