Navigation & Hierarchy

the following components help organize and navigate content, either hierarchically or sequentially these include content trees, selectors for switching hierarchies, paths in structures, tabbed interfaces, step by step wizards, and multipage guides tree view ( ihtree ) this component displays content hierarchies, such as tables of help topic contents or reading lists and their entries, similar to that often seen in file explorers or tables of contents a root node appears at the top of the tree, with its “children” displayed in a hierarchy of branches beneath it best used for/key features knowledge indexes onboarding maps admin insights & deployment tips combine with listing & topic viewer; works in content apps & training tabs example use cases knowledge base table of contents expected business outcomes easier browsing better adoption of help enable drag and drop ( ddallowed ) if checked, help authors can amend tree structure using drag and drop operations by adding listing controls to lightning pages along with a tree view , you can create hierarchies by dragging existing topics into the desired locations on the tree in addition, one can drag branches around the tree to restructure content once a tree of content has been produced, lightning page owners typically switch drag and drop off (uncheck this setting) in order to prevent help authors from inadvertently editing the tree print view level indentation ( levelindentation ) for printable view only integer defining the amount of indentation in rems to apply to each level of the tree higher numbers result in greater level indentation display printable view ( printview ) if set to true, this attribute displays a version of the tree designed for printing its contents rather than navigating content hierarchies max depth ( maxdepth ) the max depth parameter can be used to limit the number of levels of child records, counting from the root node, to display on the tree this can help to avoid recursion, and also issues where salesforce governor limits might otherwise be encountered (max soql queries, cpu time, viewstate errors etc ) the default value of zero instructs the tree to traverse the hierarchy to return all data authors should be wary of creating ‘recursive’ trees that contain child nodes that are, themselves, parents of nodes appearing elsewhere in the hierarchy node provider ( nodeprovider ) the tree view control includes its own api that can be used to display content of various kinds—not just help topics the node provider field can generally be left blank, but is used in conjunction with the api to tell the tree which tree implementation it should use to source its content in this way, you can define your own object hierarchies and display them on the tree as a compliment, topic viewer can switch dynamically between displaying help topic information and other records (via autoform) contact support for more information on implementing this attribute default tree ( rootnode ) sets the root node to be shown on the tree this is usually a help topic id unlike reading lists or guides, trees do not exist as separate entities within improved help instead, they are a representation of the help topic relationships that exist between the items to be shown as of v1 36, help topic relationships now include type information to support this traditional help topic relationships were simply of type = relative , whereas those that define trees take the form of parent\ child relationships to create a new tree, log in with suitable rights and use the tree builder tab of the improved help for lightning app alternatively, proceed as follows create a new help topic and note its id add a tree view to the desired lightning layout and set its default tree to the new topic id use the add child tool against the root node (the “ ” with the white background) to begin adding child topics display density ( displaydensity ) controls how much white space to display around the nodes on this tree (akin to salesforce’s “comfy” and “compact” density settings suppress node tools ( suppresslistingtools ) check this box to offer a simplified tree presentation with node level clickables hidden this can be useful when space is critical, trees are deep (so node labels risk being obscured by tools) and / or the desire is to present an end product taxonomy, rather than one which users are actively engaged in creating or maintaining node icon style ( nodeiconstyle ) controls the appearance of the nodes on the tree, which can be shown with or without icons tree selector ( ihtreeselector ) the tree selector control provides a way for lightning page owners to provide their users with access to multiple content hierarchies the selector displays a lightning badge for each available tree of content when these are clicked, an associated tree view can be instructed to show the relevant material best used for/key features multi context knowledge bases quick start switching admin insights & deployment tips pair with tree view; ideal for 'author vs admin' views example use cases toggle between two quick start tracks in help app expected business outcomes simplified navigation time saved tree labels ( csvtreenames ) for each supplied tree id, supply the label text to present via the selector badge tree node providers ( csvnodeproviders ) for each supplied tree id, specify a node provider (see tree view specifics, elsewhere) available tree ids ( csvtreeids ) a comma separated list of the ids of the root nodes to make available via this control clicking a tree selector badge effectively instructs any associated tree to use the clicked id as its “default tree” (see tree view specifics, elsewhere) crumb trail ( ihcrumb ) this component displays the ‘path’ one has taken within a content hierarchy the breadcrumb control has no unique parameters of its own instead, its listens to parameter should be set to the component id of an associated tree view as the user selects branches on the tree, the breadcrumb displays their path as a series of hyperlinks best used for/key features knowledge base context content navigation content apps admin insights & deployment tips add to knowledge or toolkit tabs to orient users; links auto generate from topic hierarchy example use cases display navigation path in sales toolkit expected business outcomes better orientation faster content navigation crumb colour ( crumbcolour ) 6 character (hex) colour value to use for the crumbs that form the trail default help topic ( helprecordid ) id of the help topic whose crumb trail will be sought on page load tabset ( ihtabs ) a tabset control component for custom app pages with broad presentational flexibility that shows a tab for each related help topic alternatively, you can define tabs in configuration items the standard salesforce tab component is only available on record pages as at this release of improved help in turn, this tabset control can also be used on custom app pages the component has the additional benefit of greater presentational flexibility, in that each tab can feature label text and / or an icon tabs can be styled individually, for example to have differing background and font colours tabs include meaningful tool tips (not fully implemented in the salesforce control at this stage) notwithstanding this flexibility, it is important to understand the limitations / strictures of our tabset implementation one is not able to add tabs and control their order / content via the lightning page editor instead, the page author adds the tabset component to the page, then specifies parameters that control the source of the tabs the source can be one of two types fixed tabs in this scenario, the tabset is similar to the wizard control in that its contents are entirely defined in configuration item records each tab in the collection is defined by a single record, which includes details of the label, tip text, icon and content to display related tabs in this scenario, one tab is displayed for each record related to a specified help topic best used for/key features flexible tab navigation configurable icons & hover text author friendly design admin insights & deployment tips embed in custom pages or experience sites; each tab can host any help component example use cases 'welcome / resources / faqs' on onboarding page expected business outcomes better information structure fewer clicks common tab attributes parameters applicable to tabs in either fixed or related scenarios the following parameters apply to tabs in either fixed or related scenarios suppress tab labels ( suppresslabels ) check this box to hide the text label accompanying each tab (setting ignored if icon style is 'none') icon style ( nodeiconstyle ) controls the appearance of icons against the text of each tab in the tabset related tab set tab content definition ( templateactioncode ) for related tabs only , this setting defines which components to include in each tab it uses the action code from a help configuration item record, where the type is header and the tool context is set to \[template] the supporting controls data in that record specifies the component(s) to add to each tab related tab set related listing type ( listcardconfig ) for related tabs only, the related help record type to feature select from child help display a tab for each topic that is a child of the specified help topic reading lists display a tab for each reading list to which the specified help topic is related, plus one for any featured reading lists related help display a tab for each of the specified help topic’s related relatives resources display a tab for each of the specified help topic’s related resources unfeatured reading lists display a tab for each reading list to which the specified help topic is related, but exclude any featured reading lists related tab set help topic id ( helprecordid ) for related tabs only, the id of the help topic whose relatives will define the tabs to display in this component fixed tab set tool context ( wizardname ) for fixed tabs only , the name (as defined in configuration item records) of the collection of tabs to display in the component contact improved apps for more details about how to define tab sets wizard ( ihwizard ) wizards allow the user to step through a series of defined steps to achieve a specific goal a page author adds the component to a lightning page, then selects the wizard that is to be offered to the user all aspects of the wizard are defined in the configuration item records that ship with improved help each step is defined by a single configuration item record, including step label, tool tips, instructions and the controls to present best used for/key features structured onboarding process adherence any step can contain other components admin insights & deployment tips use for role based learning journeys or data quality reviews example use cases 'new hire setup' wizard across objects expected business outcomes higher completion rates standardised process execution default wizard name ( wizardname ) the name of the wizard, as defined in configuration item records contact improved apps support for more details about the wizards that ship with improved help and how to develop others page guide ( ihpageguide ) the page guides component offer a sequence of related prompts that draw the user's attention to various parts of their application each prompt is positioned by reference to a grid of imaginary rows and columns overlying the user's screen the resolution of this grid and thus the granularity with which each prompt may be positioned is defined by the design rows and design columns attributes of the component the sequence of prompts can be defined directly on the component using its attributes or can be derived from the entries in a help reading list page guides may cover a single page or multiple screens the latter is possible only with the reading list option depending on component settings, user's may show and hide page guides at will and can also close them at any point best used for/key features general orientation change management simple onboarding based on reading lists admin insights & deployment tips launch from utility bar; each reading list entry becomes a step; not available on mobile yet example use cases 'feature tour what’s new in sales app' expected business outcomes increased user confidence fewer support queries post release design rows / design columns ( rowcount , colcount ) the number of rows and columns into which the screen area should be divided for step positioning each prompt in a page guide is positioned by reference to a 'grid' of imaginary rows and columns overlying the user's screen the resolution of this grid and thus the granularity with which each prompt may be positioned is defined by the design rows and design columns attributes of the component enter a positive integer for rows and select from one of the available column number settings bear in mind that prompts take the form of help topic viewer components positioned within the cells of the grid as such, they are constrained by the width of each column the higher the value selected for the design columns parameter the greater the horizontal positioning resolution, but also the narrower each topic will appear guide id ( readinglistid ) enter the relevant record id to derive step order, featured prompt text (from the referenced help topics), prompt positioning and any page to page navigation instructions from the entries of a help reading list alternatively, leave this setting blank to source the above information from the step pages, step positions and step topics attributes of this component if using a reading list, each reading list entry record must have the following fields populated display row the row position in the 'grid' overlaying the guided page layout at which to display the desired prompt display column similarly, the column position for more information on these values, please refer to the design columns and design rows attributes of the page guide component additionally, if it is desired to navigate between screens at any point in the guide, the relevant reading list entries must include navigation type defines the type of navigation that will occur as the user navigate to the step represented by the entry options are none the guide prompt for the entry will appear on whatever screen the user is on as they reach this step of the guide listview on entry, the user will be taken to a salesforce list view page record new the user will be taken to a record entry screen record edit the user will be taken to a record editing screen record view the user will be taken to a specified record in view mode standard tab used for navigation to certain common salesforce pages not based on lists or records, such as home screens custom used for navigation to custom lightning page layouts navigation details provides the specific information required to undertake page to page navigation for listview types, this is for new records, the object api name of the record to be created for record views and edits, the id of the specific record to feature for standard tabs, a particular layout name, such as 'home' for the home page of an app contact support for more information for custom types, the api name of the desired page layout step pages ( pages ) when no guide id is specified, define which page navigations are to be used, if any, for each step of the guide step positions ( positions ) if no guide id is set, this attribute decides where each step of the page guide appears on the screen grid it uses a comma separated list of row and column positions on an imaginary grid overlay each position is written as rn\ cn r stands for row number, c stands for column number, n is the specific number (starting at 0) example for a two step guide on a grid of 3 rows and 4 columns, to position the first step in the top left cell and the second step in the bottom right cell, enter r0\ c0,r2\ c3 the number of comma separated values supplied for step topics, step pages and step positions must match step topics ( topics ) when no guide id is specified, define which help topics are to be used for each step of the guide, entering a comma separated list of help topic ids the number of comma separated values supplied for step topics, step pages and step positions must match utility bar mode ( suppressheader ) sizes the page guide component in a way suited to use in the utility bar to navigate between pages, the page guide component should be used in the utility bar this is the only way for the component and knowledge of its steps to 'persist' as one navigates when used in the utility bar, one should launch the guide from a help button positioned in the body area of the entry / start page of the guide the utility bar mode attribute can be used to facilitate this when this attribute is unchecked (set to false), the component features a 'header' area with buttons that can be used to launch the guide when this attribute is checked (set to true), the component header and its buttons are hidden this makes the component suited for use in the utility bar (which is required for page to page navigation) in utility bar mode, add a help button to the relevant page layout and ensure that the page guide component is listening (set its listens to parameter to the positioning group attribute of the button)