how to use gallery component in Vflow. what is the format of data we have to pass?
For displaying images as a gallery view in the vFlow system there is a component named Gallery. This component displays the Images as per the shared data in the predefined format. This component designed to display images like JPEG, JPG, PNG etc. in the vFlow Execution Engine’s page design layout. For every image some default functionalities are available such as Zoom IN/Zoom Out, Rotate Left/Right, Full Screen, etc. Currently one default template available as per the below reference image:
Now required a new Gallery component template to enable new UI design for display Images in some grid or tiles format. And on selecting particular images it will expand the view and provide available options on it like Zoom In/Out, Rotate Left/Right, configured actions etc.
Pre-requisites
- User should have to configure a page in vFlow after the login journey.
- Configured page should have a minimum one row and one column layout.
- User have to create and configure Gallery component with all the required parameters and mapped under the page layout’s column.
Component Definition
Gallery Component are designed to receive images data in a defined structure from any data source defined in vFlow Mini Designer and visualize on the execution engine with different UI designs and functionalities like Zoom In/Out, Image rotation Left/Right, configured actions etc.
Pre-defined Data Format:
[{ “thumbnailUrl”: “assets/images/document.jpg”, “name”: “document”, “imageUrl”: “assets/images/document.jpg”}, { “thumbnailUrl”: “assets/images/doc-file.png”, “name”: “document”, “imageUrl”: “assets/images/doc-file.png”}]
Configuring the Component
For configuring the component users have to follow the below steps:
-
First Users have to navigate on components section from the side navigation in vFlow Mini Designer.
-
Then click on the Add Component button on the top right-hand side.
-
After clicking, POPUP opens with all the component options and users have to select Gallery and click on the next Add Component button.
-
Users have to fill the following configuration sections with all the mandatory fields
- Basic Details
- Add Images
- UI Properties
- General SettingsLayout, Dots, Description, Next/Prev Button
- Image Settings
- Basic Details
-
- Dependents
- Data Source
- When component configured, user have to map it with the pre created or configured page layout column.
- And finally, user have to publish and sync the page and verify the same on vFlow Execution application.
Configuration
- Basic Details
- Enter Component Name & Description
- Add Images or Videos or Both
Image or Video Selection
-
Add URL or list of URLs
-
Drag & Drop or Import from system folder
-
UI Properties
- General Settings
Layouts, Tag (Description), Buttons/Dots, Next/Prev Button, Auto Play, Pause
Layout
- Choose background – Colour, Image, Transparency, Opacity, etc
- Flexible Layout – Choose from carousel or layout templates (square or hexagonal grid)
- Scroll through layout – Horizontal or Vertical or both
- Zoom In/ Zoom Out (Thumbnail Size) to see more or less images – Y/N
- Set Thumbnail Size
- Zoom Out animation when mouse pointer is placed upon an image
- Choose border, padding, size, colour, styles
- Tag - Display Tagline, Display Image Number
Tag
- Choose Text Colour, Font, Size, Style, Alignment
- Choose Background Colour
- Choose Position
- Choose Animation
Dots
- Size
- Position
- Shape
- Colour
Navigation
- Next or Previous Image
- Choose Icon, Colour, Size
- Choose Icon Background Shape, Colour, Size
- Navigate to a particular image from thumbnails or dots
- Place cursor on next or previous icon to view image thumbnails small.
- Auto Play – Speed of Image
- Pause
- Loop – yes/no
- Choose Animation – Left to Right, Top to Bottom, Other effects
- Image Settings
Skins, Effects, Size, Thumbnail Layout
Thumbnail Layout
- Vertical/ Horizontal
- Right/Left/Top/Bottom
- Scroll through Thumbnails
- Favourite Image Icon display
- Number of columns or rows (x*y)
Effects
- Transition Effect
- Animation Effect
- Transition Time
- Animation Time
Skins
- Choose Skin from available layouts or Create
- Choose Default view size
- Zoom in/ Zoom Out – Using Mouse, Using +/- options.
- Rotate (Left/Right, 90/180,), Flip (Vertical, Horizontal)
- Hover over the image area – Drag to see, Show Controls on hover (Y/N)
- Full Screen Option
- Save Image, Mark Image for favourite, Copy Image URL
- Display Image Number, Tag (4/12)
- Image Border/ Padding
- Close Image View (Go back to thumbnail view layout)
- Navigate