Introducing the Teachfloor.js SDK

We’re excited to introduce the Teachfloor.js SDK, a new tool that makes it easier than ever to integrate your custom web pages with the Teachfloor platform.

Whether you're looking to create personalized experiences or enhance interactions, this SDK opens up a world of possibilities. Here’s how you can benefit from using the Teachfloor.js SDK and what you can achieve with it.

What Can the Teachfloor.js SDK Do For You?

The Teachfloor.js SDK is designed to help you connect your custom web page with Teachfloor, allowing you to build richer and more interactive experiences. With this SDK, you can:

Access User Information:

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

Benefit: Personalize the user experience on your site by displaying user-specific content or managing access based on their profile.

Respond to Changes:

React to events and changes within Teachfloor, like updates to the current page or environment.

Benefit: Keep your custom page in sync with Teachfloor, allowing for dynamic updates and interactions without needing to refresh the page.

Trigger Actions:

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

Benefit: Create a more engaging experience by providing real-time feedback and interactive elements that respond to user actions.

How Can You Use the Teachfloor.js SDK?

1. Personalize User Experiences

With the API.get() method, you can pull in specific information about the authenticated user. Imagine you're running a course and want to greet each user by name or display content tailored to their preferences. By using API.get(), you can fetch these details and customize the experience just for them.

Example Use Case: Display a personalized welcome message when users log in, or show content recommendations based on their profile.

2. Keep Your Page in Sync

The API.on() method lets you listen for changes and events within Teachfloor. This means you can update your page dynamically in response to what’s happening in the platform. For instance, if a user navigates to a different part of the Teachfloor dashboard, you can automatically adjust your page to reflect this change.

Example Use Case: Update a dashboard widget to reflect changes in a course’s status or notify users of new messages without requiring a page reload.

3. Engage with Real-Time Actions

Using the API.emit() method, you can trigger actions like showing notifications or updating elements on your page. This is perfect for creating interactive experiences where users receive immediate feedback based on their actions or events within Teachfloor.

Example Use Case: Display a toast notification to alert users of important updates or achievements, such as completing a module or receiving a new message.

Getting Started is Simple

To start using the Teachfloor.js SDK, you’ll first need to create a custom Teachfloor App through the Teachfloor Dashboard. This will provide you with a unique SDK script that you can embed in your web page. From there, you can use the SDK to build personalized, interactive experiences that enhance your integration with Teachfloor.

Ready to elevate your integration with Teachfloor? Get started with the Teachfloor.js SDK and explore the endless possibilities for customization and interaction!

For more details and to start integrating, check out our Teachfloor SDK Documentation.