QuickLinks Widget - Akumina Community

QuickLinks Widget

Quick Links Widget

For Foundation Site Installations that are not Hive, please refer to widget documentation here.

Purpose

Surface important information your users can quickly digest and navigate to.

Features

    • Features top level links and categories with fly-out menus to display second level items
    • Allows for an unlimited number of top level links and categories
    • Links can be set to open in the same window (site links) or a new window (external links)
    • In most views, supports two levels of categorization.  In the “FoundationFooterLink” and “DepartmentMenu” views only one category level is supported.
    • Supports both a list of links and menu controls
    • Easily managed via an AppManager Content App using a drag/drop, tree style UI for adding categories and links
    • Automatically adjusts the size of the main level and fly-outs to support list lengths
    • Personas can be applied to categories and links
    • Mobile-ready via Responsive Web Design

Details

    • Widget Name: QuickLinksWidget
    • Available With:  Release 5.5 and above. This article is specific to the Hive version of the QuickLinksWidget, for earlier version of this widget please visit here.
    • Content App Type: QuickLinks.  To learn more about authoring a QuickLinks please visit here.
    • Content Type: AkuminaQuicklinks
    • Content App Name: Quicklinks
    • List Name: QuickLinks_AK
    • Recommended Images Sizes: N/A
    • Dependencies:  SharePoint

Content

Root Node Title Using view “DepartmentMaster”, this is the site title and value displayed on the hamburger menu.  When you deploy a department site in FS’20 this is populated with “Department Name”, it is meant to be updated by the Business user.  Multilingual management of the department name happens on the language version of the content by updating the “Root Node Title”, in the language version of the quicklink.  In all other view cases this is the title of the root of the quicklinks and not displayed on the front end.
Category – Link Label Title that displays for this category.
Category – Link Categories can link, if set this is the url the user will navigate to when selecting the category
Category – Is Akumina Page Checked by default, uncheck this when you want to link to a modern SharePoint site page outside to of the Akumina environment.
Category – Active If checked then the category is active and displays on the front end.
Category – Open With When the category is selected, the link can be configured to open in the Same Window or New Window.
Category – Icon Icon to display along with the category title.
Link – Link Label Link Text to appear under the links icon or image
Link – Link URL – When the icon is selected the user will navigate to this link
Link – Is Akumina Page Checked by default, uncheck this when you want to link to a modern SharePoint site page outside to of the Akumina environment.
Link – Active If checked then this link will appear on the widget
Link – Open With Choices – Same Window or New Window, determines if the link opens in a new browser tab or not
Link – Icon Icon to display along with the link label
Link – Spalink N/A
Form – Form Link Label Title to appear under the form links icon or image
Form – Active If checked then this form link will appear on the widget
Form – Link Using the “Browser Form” modal a link to the selected form.
Form – Icon Icon to display along with the form link label
Form – Spalink N/A

Properties

 

Function to call after fetching data OOTB -Blank (used for widget expansion):  Name of the function called after data has been fetched by the widget.  
List Name Name of the SharePoint list that contains the data to be displayed for this widget instance.
Featured Content List Name of the SharePoint list that contains the data to be displayed for the featured menu items (defaults to FeaturedContent_AK) and the menu item will randomly display on each level one node. If this is blank then the featured menu item will not display. (5.5 Hive Install).  This is applicable for our OOTB view – MegaMenu, if not using that view leave this BLANK.
List is on Root Site When checked, the widget references the list on the root site.
Display Title If a value is entered, then the title will appear on the header of the widget depending on the view (see below).
Icon The selected icon that is displayed to the left of the widget title 
Additional selected list columns Quicklink requires certain columns that must be pulled in for them to work, those columns are not exposed on this widget property. This field allows the developer to expand the widget to pull in additional columns into the widget.
Selected list columns for Featured Context List If “Featured Content List” is populated, then this select field must be populated, it contains the columns in the “Featured Content List” to pull in and display on the featured flyout.  This is applicable for our OOTB view – MegaMenu. MegaMenu, if not using that view leave this BLANK.  Example if using MegaMenu:  Title,Body,Image,IsVideo,Link
Function to call before binding the UI events  OOTB -Blank (used for widget expansion):  Name of the function called before the UI has been rendered to the screen
Site Collection URL SharePoint site URL where the “List Name” and “Featured Content List” (if applicable) are stored
Friendly name lazy load Default set to true. Displays first level menu items and on click of arrow displays second level items.

Set to false, displays second level items on hover of menu item.

Open on click of menu button Default set to false, will load the fully visible menu instead of the hamburger menu button.

Set to true, will display the hamburger menu button to be clicked to display menu.

widgetframework Blank

Views

Below are the Views that are supported by the Quicklinks standalone widget.  There are other views that exist on this widget such as the “MyLink” view that is utilized for the quicklinks when the widget exist in another widget such as the MyLinksWidget.

View Name:  MegaMenu (5.5 Hive Install)

View Description:  Displays a visible menu with expandable set of categories and links.

View Preview:

 

View Name:  MegaMenu (5.5 Hive Install, open on click of menu=true)

View Description:  Displays an expandable set of categories and links after clicking on the menu navigation hamburger icon.

View Preview:

 

View Name:  MegaMenuDefaultVisible

View Description:  Displays the main navigation menu in an open state by default

View Preview:

View Name:  DepartmentMenu

View Description:  Hamburger expandable set of categories and links.  This view supports one level of categories.  The title of the Hamburger comes the associated quicklinks column “Root Node Title”.  This title is also used as the displayed site title.  When the OOTB department site deployer is used, this title will initially be set to “Department Name”, allows a business user to manage their preferred title for the site.  For multilingual, the site title will be updated on the language version of the quicklink content in the AppManager in this case content app “Department Menu

View Preview:

 

View Name:  FoundationFooterLinks

View Description:  Display the Links in a horizontally, the styling is on the OOTB master page.

View Preview:

 

 

Views: 1956
//]]>