Lightning Out

add help components to off platform pages with lightning out host utility this is a visualforce page (ihluxouthost) that can create and display lightning components dynamically, allowing lightning features to be exposed within non lightning environments, such as salesforce classic use cases for lightning out include creation of local, custom help topic templates that display lightning lists etc embedded in classic pages, or anywhere the help hook is used providing navigation direct to particular lightning content, such as a specific reading list, image or help topic for example, lightning out urls could be included within the body of help topic or notice rich text to facilitate linking to the desired content display of embedded help within lightning itself the host is a visualforce page and can add help hooks if desired url builder mode the lightning out host page provides a basic interface that can be used to help obtain the correct url parameters, as described elsewhere, to create help lightning components to enter url builder mode, visit the host page specifying only the following parameter lobuilder=true with parameter, no component is built; instead, a design screen appears allowing to experiment with a subset of available components and settings follow the on screen instructions to construct urls that will take you directly to the desired help lightning components via lightning out the builder includes only a subset of the available components and parameters however, the resulting urls can be modified manually (e g , by amending the comp and parms parameters) to build any help component with any desired combination of settings parameters in common with the majority of improved apps’ visualforce pages, the lightning out host is controlled through the parameters sent to it via the url note that all parameter names and values are case sensitive details are provided in the topics related to this one hideheader classic scenarios only hide page header applicable only when the user visits the lightning out host page from a classic session (i e , when not using the lightning experience) set to “false” to show the classic salesforce page header set any other value or none to suppress the header parms supplies component specific parameters to the generated item parameters (attribute information) to send to the component specified by comp, in the form attribute 1 name attribute 1 value ^ attribute n name attribute n value spaces added for clarity only do not use spaces when specifying parameters the parms parameter is used to control the specifics of the component the host is creating the parameter names and values are case sensitive and are exactly as listed for the specific components under ‘design attributes’ for example, to specify that a component should display at a height of 200 pixels with header shown and footer hidden specify the following parms=height 200^suppressheader false^suppressfooter true comp the name of the component to create, from among those offered within the nscomp namespace to create a help component, set nscomp to “iahelp” and comp to the name of the desired component, as given in the preceding sections of this document for example ihdetail = the help topic viewer ihlist = any help listing (all topics, related help, guides etc ) ihimageviewer = the image viewer ihrlviewer = the reading list viewer hidesidebar classic scenarios only hide page sidebar applicable only when the user visits the lightning out host page from a classic session (i e , when not using the lightning experience) in addition, hideheader must be set to “false” set to “false” to show the classic salesforce page sidebar set any other value or none to suppress the sidebar nscomp the namespace of the provider of the desired component the host is able to create copies of its own lightning components or certain of those offered by salesforce only components that are defined within the dependency app ( nsapp\ app) can be created attempts to use any other components may fail set nscomp to “iahelp” when creating components from improved help set nscomp to the namespace of the provider of the desired component in other cases common values may include aura force lightning ui app this is the name of the dependency app to reference used in conjunction with nsapp, this is the name of the dependency app to reference to use the in built dependency app (which will mostly be what is required) set app to “appih” to use a locally defined app, enter the name of that app nsapp the nsapp parameter is the namespace of the dependency app to use in order to create components reliably, lightning out requires a “dependency app”, akin to the manifest files used in languages such as c and our chrome browser extensions (the dependency app is an aura\ application, which can be defined via developer console in the hosting org ) the app describes the resources that will be required if these resources are not present, lightning out will fail gracefully (by not attempting to produce requested components) rather than creating objects that cannot be supported and could otherwise fail erratically as a consequence improved help includes a suitable dependency app but, in the interests of potential extensibility, the lightning out host allows for one to be created locally and used when creating components the nsapp parameter is the namespace of the dependency app to use to use the in built dependency app (which will mostly be what is required) specify the improved help namespace (iahelp) to use a locally defined app, one would typically specify “c” (similar to locally defined help topic templates, where the page urlis entered as “c vfpagename”) lightning out this section shows some example lightning out host urls carriage returns have been added to example urls for clarity replace {red text in braces}with values from your org image viewer invoked from a classic session with salesforce header visible \[org’s visualforce root]/apex/ihluxouthost ?hideheader=false \&nsapp=iahelp \&nscomp=iahelp \&app=appih \&comp=ihimageviewer \&parms=height 800^mediawidth 50^imagetitle hello world^nodatamessage image tba^imageurl {url} link directly to a reading listin the lightning viewer \[org’s visualforce root]/apex/ihluxouthost ?nsapp=iahelp \&nscomp=iahelp \&app=appih \&comp=ihrlviewer \&parms=helprecordid {reading list id}^height 550