How can I call a Webflow interaction using jQuery or JavaScript?

Published on
September 22, 2023

To call a Webflow interaction using jQuery or JavaScript, you can utilize Webflow's JavaScript API. Here's how you can achieve this:

  1. Get the interaction trigger element: In order to call a Webflow interaction, you need to identify the element that triggers the interaction. This can be a button, a link, or any other HTML element on your page.

  2. Pick a suitable event: Choose the appropriate event that you want to associate with the interaction trigger. Common events include click, mouseover, scroll, etc.

  3. Add the Webflow interaction class: Add the class name of the Webflow interaction to the interaction trigger element. You can find this class name in the Webflow Designer under the "Element Settings" panel. Look for the "Add class" field and enter the class name that corresponds to your interaction.

  4. Call the Webflow API: To actually trigger the interaction, you will need to call the Webflow JavaScript API. This API provides a number of methods that allow you to interact with your Webflow site.

  5. Call the interaction method: Use the Webflow API's run() method to run the interaction. This method requires two arguments: the interaction name and an optional options object.

Example code:

// Get the interaction trigger elementvar triggerElement = document.getElementById('my-trigger-element');// Add the Webflow interaction classtriggerElement.classList.add('my-interaction-class');// Call the Webflow API and trigger the interactiontriggerElement.addEventListener('click', function() {  Webflow.require('ix').run('my-interaction-name');});

Remember to replace 'my-trigger-element' with the ID or class of your interaction trigger element, 'my-interaction-class' with the class name of your Webflow interaction, and 'my-interaction-name' with the name of your interaction.

By following these steps, you can successfully call a Webflow interaction using jQuery or JavaScript. This allows you to add interactivity and animation to your Webflow site beyond the capabilities of the Webflow Designer alone, giving you more control over your website's behavior.

Additional Questions:

  1. How do I trigger a Webflow interaction on scroll?
  2. Can I use custom JavaScript code in Webflow?
  3. How can I control the speed of a Webflow interaction?