Expand my Community achievements bar.

Guidelines for the Responsible Use of Generative AI in the Experience Cloud Community.
SOLVED

DPS 2015 API Documantation

Avatar

Level 5

Hi, Is there any more documentation out there on how to implement the Gesture APIs? I have the sample files, we just cant figure out how to apply the API to our HTML overlays from the current documentation. Mainly we are trying to stop the nav bar from coming down when a user taps on an html overlay.

Thanks!

Jeff

1 Accepted Solution

Avatar

Correct answer by
Employee
7 Replies

Avatar

Correct answer by
Employee

Hi Jeff,

All our documentation and code samples for the API are available at https://forums.adobe.com/servlet/JiveServlet/downloadBody/6121-102-1-8030/20150706%20Adobe%20DPS%202....

Neil

Avatar

Level 5

Thanks Neil. I've had these files for weeks and my programer has yet to understand how to call the API in the html or apply the API to the html content from the available documentation.

He is confused by the example given in the pdf as he is struggling to find '#slideshow-container-one' in the example code to see how it works etc. We only want to stop the nav from coming down regardless of where the user taps on the web overlay.

Can you provide a clearer understanding of how to use the API for this? What would the html look like for a web overlay that's calling the API to disable the chrome?

Jeff

Avatar

Employee

You need to:

1) Include the .js file in your HTML

2) Wire up an event handler when the document loads

3) Call adobeDPS.Gesture.disableNavigation() and pass in the top-level element for your page (I guess the body element)

Unfortunately I'm not much of a JavaScript developer, however steps #2 and #3 (passing the top-level element to a function) are pretty fundamental JS tasks that should be well-documented on the web.

Neil

Avatar

Level 5

Thanks, I'll pass on the info as I also know little about JavaScript.

Jeff

Avatar

Employee

Hi Jeff,

You can wrap the function call that Neil mentioned in the standard $(document).ready():

<html>

<head></head>

<body>

<script src="/path/to/dpsHTMLGestureAPI.min.js"></script>

<script>

     $(document).ready(function() {

          adobeDPS.Gesture.disableNavigation();

     });

</script>

</body>

</html>

The PDF example was showing how you can disable a particular element within the HTML  (i.e. a slideshow) by passing in the element(s) into the disableNavigation() function. If you just call disabledNavigation(), as shown above, you will disable the navigation for all elements.

Avatar

Level 5

Awesome! Thank you for this piece!

Jeff

Avatar

Level 5

Just a followup, we have achieved success using the code example you provided! Thank you!

Jeff