Documentation Listing

The Documentation Listing component is designed to organize and display a list of documents or resources within the application. This component allows users to view, search, and navigate through various documents or entries in an orderly and structured format. It is particularly useful for managing documentation, guides, manuals, or any content that requires a list-based display.

Key Features:

• Search and Filter Options:
  The Documentation Listing component often includes a search bar or filtering options, enabling users to quickly locate specific documents by title, keywords, or tags.
• Sortable Columns:
  Users can sort the list by different attributes, such as document title, date of creation, author, or category. Sorting helps users find relevant documents more efficiently.
• Pagination:
  If the list contains a large number of documents, pagination controls can be added to navigate through the list page by page. This improves usability by preventing long, overwhelming lists.
• Document Preview:
  Each entry in the Documentation Listing may include a brief preview or description of the document, allowing users to get a quick overview before deciding to open or download it.
• Download and View Options:
  The component can offer users the ability to directly download or view documents in various formats (e.g., PDF, Word, Excel), making document access more convenient.

Common Use Cases:

• User Manuals:
  Display a list of product manuals, guides, or instructions for end-users.
• Internal Documentation:
  Organize internal company resources, such as policies, procedures, and technical documentation, for easy access by employees or administrators.
• Knowledge Base:
  Present a searchable and categorized knowledge base that users can explore to find relevant articles or troubleshooting steps.

Creating a Documentation Listing

1. Under Inventory (), click “Component“, which is on the second left panel.

2. Click Create placed on the second horizonal panel from the top, and a dialog box “Create Component” pops up.

3. Select Type as “Documentation Listing“, Name it in the text box and click “Create“.

4. When you click Create (), Basic option of Config menu for the Documentation Listing opens.
5. Now you will see the following menu options:
   • Basic
   • Properties
   • Style
   • Animation
   • Events
   • Elements
   • Data

Note: You can create this component in the layout option of the configurator section as well. After this, you can follow the process given below.

Basic

Basic Properties	Description
Type	The Component Type indicates the type of component you are adding. In this case, it defaults to “Documentation Listing” and cannot be changed here. This selection is made initially when you create the component.
Reference Name	The Reference Name is a unique identifier assigned to the component for internal use. This name is visible only to vFlow users, and is not displayed to end-users. The Reference Name is intended for your convenience, helping you easily identify and manage the component throughout.
Description	The Description field is intended for use by application designers or administrators (vFlow users) to provide additional context or details about the component. This description is not visible to end-users and is used solely for internal reference to assist with component management.

Properties

Properties	Description
Download Image	To enable download image option in the list of the documents, click to select the checkbox.
Print Image	To enable the Print Image command in the list of the documents, click to select the checkbox.
Visible Tags	Clicking this checkbox will make the tags visible.
Display Information	To display the Information, click this checkbox.
Visible Comments	To make the comments visible, select this checkbox.
Document Viewer Template
Header	It is displayed on the top of the component. To know more about header, click here or see the Header section under the System Components.
Footer	It is displayed on the bottom of the component. To know more about footer, click here or see the Footer section under the System Components.

Style

The Style option allows you to personalize the appearance of the Documentation Listing. This includes adjusting various visual aspects to ensure it complements your application’s branding and overall design. Here’s a breakdown of different settings that you can make adjustments to::

• Large Screen Width: The Documentation Listing width is adjustable by entering a percentage value in the text box. For example, if the width is set to 100%, the Documentation Listing will take the full width of the screen.
• Transparent: When you click to select this checkbox, the Documentation Listing will have a transparent background, allowing it to blend into the background of the page or layout.

• Background Color: To choose the background color for the component, you can use a color picker or enter a hexadecimal or RGB color code. The default opacity is set to 100%.

• Font:
  • Family: You can select the font family for text in the component. If no specific font is chosen, “None” will use the default font.
  • Size: You can specify the font size in pixels (px).
  • Color: You can set the font color using the color picker or a hexadecimal or RGB color code. The default opacity is 100%.

• Alphabet Case: You can choose the text case (e.g., uppercase, lowercase) or select “None” to keep the original case.

• Text Alignment: You can set the text alignment (e.g., left, center, right) or select “None” for default alignment.
• Dimension:
  • Height: You can define the height of the component in pixels (px) or percentage (%).
  • Maximum Height: You can set the maximum height to prevent the component from exceeding this limit.
  • Width: You can specify the width of the component in pixels (px) or percentage (%).
  • Maximum Width: You can define the maximum width to prevent the component from expanding beyond this size.
• Spacing:
  • Margin: To adjust the space around the component, enter values for top, right, bottom, and left margins in pixels (px). Default is 0px for all sides.
  • Padding: To set the internal space within the component, enter values for top, right, bottom, and left padding in pixels (px). Default is 0px for all sides.
• Border Radius: To define the curvature of the corners of the component, enter values for top-left, top-right, bottom-right, and bottom-left in pixels (px). Default is 0px for all corners.
• Custom CSS Class Name
  • Users can enter custom CSS class names in the provided input field to apply additional styles.
  • Multiple Classes Names can be provided, If needed. They can be applied by separating them with commas, as indicated by the example (classA, classB).

These settings allow you to tailor Documentation Listing to your specific design preferences and requirements.

Animation

This option allows you to apply several animations to enhance the component’s loading appeal. The following are the available animations:

1. Bounce
2. Flash
3. Pulse
4. Rubber Band
5. Handshake

Their Configuration:

1. Click the Type list, and then select an animation to apply an effect when the component loads.
2. After you select one of the animations (for example, Bounce), you will see the following configuration options:
   • Speed: In this field, you can select one of the following options to adjust the speed of the animation:
     • Faster
     • Fast
     • Slower
     • Slow
   • Delay: Click this list to select a value (for example, 3 seconds). This value specifies a time period. The application will load the animation after this time period (for example, 3 seconds).
   • Repeat: In this list, select a value (for example, 2). This value specifies the total number of times the application will play the animation.
     
3. After you configure the component’s animation properties, click to apply them to the component.

Events

The Events option of the Documentation Listing component, as shown in the image, allows you to assign task groups that will execute when specific actions occur within the component. These tasks can be created separately in the configurator or inventory and can be grouped to perform various actions when certain events are triggered.

Here’s a breakdown of the Events section:

1. On Load:
   • This option lets you assign a task group that executes automatically when the component is loaded.
   • You can select an existing task group from the dropdown list labeled Select Task Group or go back to the inventory or configurator to make a task or task group if needed.
   • This could be useful for initializing data or triggering other actions as soon as the Documentation Listing component is displayed.
2. Custom Load:
   • The Custom Load event enables you to trigger a specific task group during a customized loading scenario.
   • Similar to the previous options, you can choose the task group to be executed from the Select Task Group dropdown list or go back to the inventory or configurator to make a task or task group if needed.

After assigning the appropriate task groups to these events, click the button to apply your configuration to the component.

In summary, the Events section provides flexibility in automating actions within your Documentation Listing by linking predefined tasks to occur during the component’s loading process. This customization ensures a more dynamic and interactive user experience, tailored to your application’s specific needs.

Elements

You can add elements such as hyperlinks, mat-icon, text, and images to the component.

Note: You can read about the elements here in detail.

Data

1. Mention Document Folder Path to fetch all the documents under the documentation listing.

2. If you want to fetch and show some data in the card, select one of the data types that fits best for the business requirements:

Note: To know more about Data, click here or check the post under configurator.