Skip to content

A Salesforce Lightning Component that allows users to show useful links for users on Lightning pages

License

Notifications You must be signed in to change notification settings

Clint-Chester/helpful-links-component

Repository files navigation

Helpful Links Component

Codacy Badge Language grade: JavaScript Total alerts codecov

A Salesforce Lightning Component that allows users to show useful links for users on Lightning pages.

Helpful Links Component

Deploy Package

Features

The three types of content that can be populated in this component are:
  • URLs - any web urls internal or external to Salesforce. Comman usages in the past have been links to popular dashboards as an example.
  • Salesforce Files and Salesforce Content - for any files or content that have been uploaded into Salesforce, a record id for each file / content item can be provided and the native preview functionality will be used to view this information. These instructions assume that you have configured the correct security requirements for users to be able to view the files and content.
  • Salesforce Object Records - navigate to any record in Salesforce by simply providing the record id

The following lists key features regarding this component and the options available via Lightning App Builder:

  • Navigation Options - this option to determines whether the content link is either for a URL, Salesforce Content or Salesforce Object Records.
  • Show Title - this checkbox controls whether you need to display a title for your helpful links. You may not want to show a title if this links list is already under a tab for example. If you are wishing to chain lists together, ensure this is unchecked.
  • Chain Lists - enabling this checkbox counteracts the enforced margins Salesforce puts in place when dropping a Lightning Component on a Lightning Page. Currently that enforced margin is 1rem. Enable this feature if you are looking to have a single list which is mixed with URLs and Salesforce Files / Content.

How to use this component

There are some key points that need to be considered when populating content for this component:

  • For creating items in the links list, each item is created by separating each thing with a semicolon. e.g. Link 1;Link 2 will result in creating two items being displayed in the links list. It is essential that Link Icons, Link Titles, Link URLs or Record IDs and Link Descriptions are all the same length.
  • If you are not wanting to add descriptions for your links as an example just leave blank spaces e.g. ; ;

The following lists out the steps involved when filling in content for this component via Lightning App Builder:

  1. Title - Complete the title field if you are showing a title for this helpful links component
  2. Link Icons - The icons for each item in the list are inheritied from Salesforce's Lightning Design System. The Lightning Design System name of the icon is used for each item in the list. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed. All icons available can be found here. For each icon in the list they must be separated by a semicolon.
  3. Link Titles - The clickable element that will be displayed for the users. For each link title in the list they must be separated by a semicolon.
  4. Link URLs or Record IDs - If the Salesforce Content Links checkbox is enabled, enter each record id of the file separated by a semicolon. If this checkbox isn't enabled, enter the URL for each item in the list separated by a semicolon.
  5. Link Description - The description that is dsiplayed underneath the link title. Each description must be separated by a semicolon for each item in the list. If you don't want to add a description add semicolons with blank spaces e.g. ; ;

About

A Salesforce Lightning Component that allows users to show useful links for users on Lightning pages

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published