Skip to content

Commit

Permalink
new package, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shliachtx committed Jun 8, 2020
1 parent 9dea7a7 commit ccfb38a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@

_No warranty is provided, express or implied_

[Install unlocked package](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t6g000008SZyYAAW) version 0.8.0
[Install unlocked package](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t6g000008SZzRAAW) version 0.9.0

## Release Notes
### 0.9.0
- Change live data updates to use PushTopic
### 0.8.0
- Add support for Change Data Capture.
### 0.7.0
Expand Down Expand Up @@ -41,9 +43,7 @@ To deploy authorize a dev hub in sfdx and run `$ sfdx force:org:create -f config
### [datatable](force-app/main/default/lwc/datatable)
Takes as input an sObject and an array of fields and populates a datatable with records from the database.

To enable Change Data Capture (live updates) follow instructions here: https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_select_objects.htm

Note: Normal Change Data Capture limitations apply https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_allocations.htm
Note: Streaming update support utilizes the PushTopic feature, which has a maximum of 50 PushTopic records per org. The datatable uses one for each object type that has live updates enabled. They can be deleted or deactivated if necessary - use `SELECT Id, IsActive FROM PushTopic WHERE Name LIKE 'easydt__%` to retrieve them via SOQL.

### [Custom Related List](force-app/main/default/lwc/relatedList)
Related list for use on lightning app and record pages. Choose object, fields, etc.
Expand Down
2 changes: 1 addition & 1 deletion force-app/main/default/lwc/datatable/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Name | Type |Read only | Required | Description | Default value
`enable-infinite-loading`|boolean|||automatically load more records when user reaches the end of the datatable|`false`
`records-per-batch`|integer|||number of records to load when the end of the datable is reached|`50`
`initial-records`|integer|||number of records to load initially|`this.recordsPerBatch`
`enableLiveUpdates`|boolean|||update records using Change Data Capture|`false`
`enableLiveUpdates`|boolean|||update records using PushTopic|`false`
`selected-rows`|array|✔||array of selected IDs from datatable
`query`|string|✔||generated query string used to retrieve data
`record-count`|integer|✔||total number of records returned by current query
Expand Down
5 changes: 3 additions & 2 deletions sfdx-project.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"path": "force-app",
"default": true,
"package": "lwc",
"versionNumber": "0.6.0.NEXT"
"versionNumber": "0.9.0.NEXT"
}
],
"namespace": "easydt",
Expand All @@ -23,6 +23,7 @@
"[email protected]": "04t6g000004O28tAAC",
"[email protected]": "04t6g000004OWs4AAG",
"[email protected]": "04t6g000008fW6kAAE",
"[email protected]": "04t6g000008SZyYAAW"
"[email protected]": "04t6g000008SZyYAAW",
"[email protected]": "04t6g000008SZzRAAW"
}
}

0 comments on commit ccfb38a

Please sign in to comment.