Simple plugin to Scroll the whole App or a Container to an object position with an optional animation.


Description


The neoScroll plugin for VisualNEO Web provides smooth scrolling functionalities, enabling the application or a specific container to scroll to a particular element or pixel position with an optional animation effect. This plugin is highly suitable for applications needing guided navigation, such as single-page applications, content-heavy sites, or interactive tutorials. Here’s an overview of its main features and practical usage:

Scrolling the App to a Specific Element

The neoScrollAppToObject command allows the entire application view to scroll smoothly to a specified object’s position within the app.

    • Command: neoScrollAppToObject
    • Syntax: neoScrollAppToObject "element" duration
      • element: The ID of the target object to scroll to.
      • duration: Duration of the animation in milliseconds.

Example:

neoScrollAppToObject "section2" 800

This command scrolls the app view to section2 over 800 milliseconds​.

Scrolling the App by a Specific Number of Pixels

The neoScrollAppToNumber command scrolls the entire app by a specific number of pixels, creating smooth navigation between content sections.

    • Command: neoScrollAppToNumber
    • Syntax: neoScrollAppToNumber number duration
      • number: Number of pixels to scroll vertically.
      • duration: Animation duration in milliseconds.

Example:

neoScrollAppToNumber 300 500

This command scrolls the app view down by 300 pixels over 500 milliseconds​.

Scrolling a Container to an Internal Object

The neoScrollContainerToObject command scrolls a specific container to an internal object, making it useful for content-heavy containers with overflow elements.

    • Command: neoScrollContainerToObject
    • Syntax: neoScrollContainerToObject "objId" "element" duration
      • objId: ID of the container.
      • element: ID of the object within the container to scroll to.
      • duration: Duration of the animation.

Example:

neoScrollContainerToObject "contentBox" "paragraph5" 400

This scrolls contentBox to bring paragraph5 into view within 400 milliseconds​.

Scrolling a Container by a Specific Number of Pixels

The neoScrollContainerToNumber command scrolls a container vertically by a set number of pixels.

    • Command: neoScrollContainerToNumber
    • Syntax: neoScrollContainerToNumber "objId" number duration
      • objId: ID of the container to scroll.
      • number: Number of pixels to scroll.
      • duration: Animation duration in milliseconds.

Example:

neoScrollContainerToNumber "textContainer" 200 300

This scrolls textContainer down by 200 pixels over 300 milliseconds​.

Practical Applications

The neoScroll plugin is ideal for:

    • Smooth Navigation: Scrolling to different sections or elements within a single-page application.
    • Guided Tutorials: Navigating users through specific content or form fields.
    • Content Exploration: Smoothly navigating through long content or overflow containers.

By offering smooth, controlled scrolling, the neoScroll plugin enhances user experience, making it easy to guide and focus users’ attention on key content areas within VisualNEO Web applications.

 

neoScrollAppToObject

Purpose:

Scrolls the App to an object position

Category:

neoScroll

Syntax:

neoScrollAppToObject "element" duration

 

element

Object to scroll to

duration

Animation duration in milliseconds

 

neoScrollAppToNumber

Purpose:

Scrolls the App to a number

Category:

neoScroll

Syntax:

neoScrollAppToNumber number duration

 

number

Number of pixels to scroll to

duration

Animation duration in milliseconds

 

neoScrollContainerToObject

Purpose:

Scrolls a Container to an internal object position

Category:

neoScroll

Syntax:

neoScrollContainerToObject "objId" "element" duration

 

objId

Container to scroll

element

Internal Container object to scroll to

duration

Animation duration in milliseconds

 

neoScrollContainerToNumber

Purpose:

Scrolls a Container to a number

Category:

neoScroll

Syntax:

neoScrollContainerToNumber "objId" number duration

 

objId

Container to scroll

number

Number of pixels to scroll to

duration

Animation duration in milliseconds

Created with the Personal Edition of HelpNDoc: Make Help Documentation a Breeze with a Help Authoring Tool