Common Attributes

the following are the common design attributes shared across multiple lightning components these are configurable in the lightning app builder and apply to behaviours like appearance, context, and interactions content configuration attributes that manage the initial content or fallback messages default / related help record ( helprecordid ) the id of a (related) help record to display for topic viewer components, the id of the help topic to display on loading enter '\[none]' to start with no topic, or one defined by an author configuration record for listings, this setting is applicable to 'related' listing types only in these cases, enter the id of the help topic to which to contextualise for the reading list viewer, enter the id of the reading list to be displayed for the tabset component, this setting is used for 'related' tabs only (i e , those defined by a related record as opposed to a named tab set) in these cases, enter the id of the record whose related records (such as child help topics or reading list entries) are to be used to produce tabs no data advice label ( nodatamessage ) a message to display on this component when no data is present a message to display on this component when no data is present, for example when search results return no data or the component is awaiting a “record selected” event in order to synchronise its display of related records customers may wish to use this parameter to advise users what to do to cause data to appear (e g , “click an item in the list on the left of this page to see related help”) encourage users to request / create help (e g , “no help here? please advise support”) appearance and styling attributes controlling visual elements and themes background style ( backgroundstyle ) controls the appearance of the background of the component select coloured to have the component adopt the background colour specified in its colour scheme select transparent to make the component background 'see through', effectively giving it the background colour of the underlying page colour scheme ( uxtheme ) governs which of several available brand colour schemes to apply to the component help administrators are able, via improved help global settings, to define a series of key colours to use throughout improved help these are grouped into named schemes, which offer contrasting but complimentary palettes that can be applied to help's lightning components as of this release, the available schemes are light and dark enter one of these two values for colour scheme, or leave this setting blank to utilise the default scheme from help global settings suppress header / footer ( suppressheader & suppressfooter ) control whether or not to display the header / footer areas of a component respectively these check boxes allow page owners to decide whether or not to display the header area of a given component (i e , its title, header , drop down and ellipsis tools) and / or its footer (i e , the diagnostics area beneath the component’s body) diagnostics feature controlled by global help settings this is not a component design attribute but a feature controlled by global help settings the footer area of all lightning components includes status message text of various kinds optionally, this text can feature an on click action exposing advanced diagnostics information behaviour is controlled via global settings with diagnostics off, text is formatted in a ‘standard’ colour and cannot be clicked with diagnostics on, text appears in a highlight colour and, when clicked, causes a diagnostics message to appear layout & sizing attributes for sizing the component component height ( height ) display height for the component in the case of the qam, this is the height of the main body of the component when opened depending on the component, the value can be expressed as an integer representing a fixed height in pixels 1 = adopt the height required in order to display content without a scrollbar 2 = fill the available screen height interaction behaviour attributes for component interactions and referencing tool context ( toolcontext ) defines the set of clickables (ellipsis menu items, listing tools, drop downs etc) to present on a component a component's tool context design parameter setting controls the collection of clickables (ellipsis menu items, listing tools, drop downs etc) that are to be made available to the user clickables are defined by configuration item records, which include the 'tool context' pick list field this field allows individual tools to be grouped for presentation in different scenarios for example the topic viewer component used as part of the help portal has its tool context set to '\[default]', so the standard set of viewing and editing facilities are visible the same component when viewed as part of a reading list editing dialogue has a tool context of readinglistbuilder , resulting in a simplified collection of clickables more focussed on the task in hand it's worth being aware that individual tools can also be removed from view (temporarily or otherwise) by setting their tool context field to '\[hidden] ' when adding a component to a page layout, set the tool context design parameter as follows enter a value from the tool context pick list field of the configuration item object to see tools defined for that context enter \[default] to accept the default toolset for the component all values are case sensitive component id ( componentid ) a reference name for the component, used in conjunction with the 'listens to' parameter note that, in the case of the quick access menu, component id is hard wired to theqam components communicate / interact with each other by means of events for example, clicking a listing item raises a record selected event when events are raised, they are marked with the id of the component that raises them, allowing other page components to differentiate between sources and respond or ignore messages accordingly