Skip to main content
Teachfloor.js SDK

Learn how to use the Teachfloor.js SDK to integrate custom web pages, personalize user experiences, and trigger real-time actions.

Filippo Schiano di Pepe avatar
Written by Filippo Schiano di Pepe
Updated over 2 weeks ago

The Teachfloor.js SDK is a powerful tool designed to seamlessly integrate your custom web pages with the Teachfloor platform. Whether you aim to personalize user experiences, sync your content dynamically, or trigger real-time actions, this SDK unlocks new possibilities for enhancing learning interactions.


What Can the Teachfloor.js SDK Do For You?

1. Access User Information

Retrieve details about the current user, such as their name and profile data.

  • Benefit: Personalize content based on user profiles, such as displaying custom greetings or course recommendations.

2. Respond to Changes

React to in-platform events like page navigation or updates.

  • Benefit: Keep your custom web page synchronized with Teachfloor, enabling dynamic updates without page reloads.

3. Trigger Actions

Initiate actions within Teachfloor, such as displaying notifications or updating content.

  • Benefit: Create engaging, real-time interactions that enhance user engagement.


How Can You Use the Teachfloor.js SDK?

1. Personalize User Experiences

Use API.get() to fetch authenticated user details.

Example Use Case:

  • Display a personalized welcome message.

  • Show user-specific content based on profile attributes.

2. Keep Your Page in Sync

Use API.on() to listen for changes and updates within Teachfloor.

Example Use Case:

  • Automatically update a progress tracker when a user completes a lesson.

  • Notify users of new course discussions in real time.

3. Engage with Real-Time Actions

Use API.emit() to trigger in-platform actions like notifications.

Example Use Case:

  • Display a toast notification when a learner completes an activity.

  • Prompt users with a confirmation message before submitting assignments.


Getting Started

To begin using the Teachfloor.js SDK:

  1. Create a Teachfloor App through the Teachfloor Dashboard.

  2. Embed the SDK script into your web page.

  3. Start using API methods (get(), on(), emit()) to enhance user interactions.

For detailed integration steps and examples, refer to the Teachfloor SDK Documentation.
​

Unlock new possibilities for customization and engagement with the Teachfloor.js SDK today!

Did this answer your question?