Skip to content

Commit 8508165

Browse files
committed
Update Readme
1 parent cc4da73 commit 8508165

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ JS buttons are back in Lightning! For now, at least. And they are even more powe
66

77
The button can be made available to users via a quick action powered by the `jsButtonQuickAction` component. The actual JavaScript should be entered into a `JS_Button__mdt` custom metadata record, into the `Script__c` field with the same name as the name of the SObject. The repo contains a couple of samples for Account and Contact. The corollary is that, out of the box, only one button per SObjecttype may be supported.
88

9-
### The syntax
9+
### The Syntax
1010

1111
This is the fun part. The syntax is quite permissive, with some restrictions, which I will cover below. I haven't, obviously, explored all possible scenarios and the information may still be incomplete. Please raise an issue if you come across something I haven't covered.
1212

@@ -40,7 +40,7 @@ alert(acct[0].NumberOfEmployees);
4040
$A.get('e.force:refreshView').fire();
4141
```
4242

43-
### About the syntax
43+
### About the Syntax
4444

4545
* Note how the syntax is linear for SOQL and DML. Coupled with JavaScript's support for manipulating arrays, this makes it easier to manipulate data, even compared to Apex in several instances.
4646
* SOQL and DML statements must be enclosed in `||`. Semi-colon can be inside or outside the `||`
@@ -50,12 +50,13 @@ $A.get('e.force:refreshView').fire();
5050

5151
### Known Limitations
5252

53+
* Support for delete has been intentionally withheld.
5354
* Single-line comments are not supported.
5455
* Haven't tested DML with date, datetime, boolean, geolocation and other compound fields. I will update this section as I do so.
5556
* Explicit use of async/await, Promises and Generators is not supported, atm.
5657
* DML on Files, Attachments, Documents, etc. is not supported
5758

58-
### Developers: Extending to more than one button per SObject Type
59+
### For Developers: Extending to more than one Button per SObjectType
5960

60-
If you need more, you may create lightning component quickActions with the name of the custom metadata record containing your JS passed in to the `jsButton` child component. You will also need to implement an `init` method to invoke the controller method in `jsButton`. Refer to the `jsButtonQuickAction` component for more details
61+
If you need more than one button on an SObjectType, you may create a lightning component quickAction with the name of the custom metadata record containing your JS passed in to the `jsButton` child component. You will also need to implement an `init` method to invoke the controller method in `jsButton`. Refer to the `jsButtonQuickAction` component for implementation details
6162

0 commit comments

Comments
 (0)