Cheers to the Future - Custom Lightning Action

I know despite of what Salesforce says here to Break Up with JavaScript Buttons and Embrace Lightning and suggests the First Steps: to replace JavaScript Buttons -with Lightning Actions( because they are Smart, Fast, and Mobile, we all still continue to miss our mighty old friends(On-Click Javascript buttons) when we run into situations highlighted below when despite of all suggested we are still unsure of the way out,

[Update] Do checkout the new Lightning Transition Toolkit here https://partners.salesforce.com/partnerNews?id=a033A00000GVxZXQA1

To do following currently hurts as there`s no straightforward to perform the below listed seemingly simple tasks,

• Button with simple ‘Are you sure?’ confirm box.
• Button with conditional ‘Are you sure?’ confirm box.
• Button which does conditional redirection.
• Button that simply does API callouts to an external system (no UI required!)
• Button which opens up a prefilled form.
• Button which just calls an Apex method to do the needful.
• Button that can leverage the power of OOB events that are handled in the Salesforce mobile app and Lightning Experience
• Button that can redirect to another Lightning Component or open up the component inside a modal.

What if I tell you can do all mentioned above with all pointNclicks and very minimal code, Sounds Magical Right, here we go here`s the component code uploaded on GitHub https://github.com/struckbylightning/customLightningAction/tree/master/CustomLightningAction

All you need to do is dragNdrop 'customLightningAction.cmp' to record detail page and configure few design parameters(ref table at end for details) and woof you are all set :)

Now let`s straight away jump to see the component in action, with help of below scenarios,

1. Always Confirm box + redirect to component example

• Let`s say on click of ‘Create Sales Order’ button on Account Record we want to always show a confirm box with ‘Are you Sure?’ message with Yes/No buttons, and then,
  • If user clicks Yes, redirect them to ‘newSalesOrderWizard.cmp’(1a) or open the component in modal(1b).
  • If clicks No then close the confirm modal.

1a. Redirect to Component on confirm

1b. Open Component in a Modal on confirm

2. Conditional Confirm box + call Apex example

• Now Let`s say on click of ‘Create Sales Order’ button on Account Record we want to first do a Credit Status check and accordingly show a Confirm Box on basis of the results,
  • If Account.Credit_Status__c == ‘Red’ we want to show a message ‘This account has been marked Red are you sure you want to create a new Sales order?’, and then,
    • If user clicks Yes then call ‘createSalesOrder’ apex method.
      • If clicks No then close the confirm modal.
  • Else call ‘createSalesOrder’ apex method

3. Validate Prior Redirecting + Fire Event example

• Let`s say on click of ‘Create Sales Order’ button on Account Record we want to first do a Credit Status check and accordingly stop user from proceeding on basis of the result,
  • If Account.Credit_Status__c == ‘Red’ we want to show a message ‘You cannot place new Sales order as Finance has marked this account Red, Check with Finance team for more info’. and block the user from proceding.
  • Else Fire force:createRecord event

This package comes with other reusable freebies which are ingrained into this component but can be easily decoupled and utilized.

• loadingSpinnerComp - Simple component to show a centered spinner on basis of a boolean attribute
• genericUtilities.cmp, GenericDataSaverApxCtrl.apxc, APXFieldValidationError
• To simplify performing DMLs from LC and also support a better error handling mechanism which helps with finite details around failing validation rules in a consumable way
• LightningServerResponse - Any call to Apex will always return LightningServerResponse (in component I build, Why?- probably will write another post explaining all these antics)