Skip to content

Commit

Permalink
#43 Preliminary documentation for refresh (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
madmax983 committed Jan 30, 2018
1 parent de6ff48 commit fe6fec4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,8 @@ Decorators and Editors implement the cellFacet interface. Check out the defaultD
You can look at the DefaultSearch component to see how a global search for the grid is being implemented, and how you could change it to implement your own search. The GetAttribute event can be used to get any attribute off of the grid, and takes a callback that can be invoked with that value. The DefaultSearch uses this get the grid data, but it can be used for other use cases outside of this. It then filters out the matches it wants, and sends a GridViewMutation event, which sets the current grid view. The plan is to use this event for sorting and filtering as well.

Look at DataGridImpl component for an example of all of this being setup.

## Methods

Init: Once you have the data for the Grid, you can call the init method on it, and the grid will take care of setting everything up and rendering the view.
Refresh: Call refresh on the grid when you change the data structure.
4 changes: 4 additions & 0 deletions force-app/main/default/aura/DataGrid/DataGrid.auradoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@

You can look at the DefaultSearch component to see how a global search for the grid is being implemented, and how you could change it to implement your own search. The GetAttribute event can be used to get any attribute off of the grid, and takes a callback that can be invoked with that value. The DefaultSearch uses this get the grid data, but it can be used for other use cases outside of this. It then filters out the matches it wants, and sends a GridViewMutation event, which sets the current grid view. The plan is to use this event for sorting and filtering as well.
</p>
<p>
Init: Once you have the data for the Grid, you can call the init method on it, and the grid will take care of setting everything up and rendering the view.
Refresh: Call refresh on the grid when you change the data structure.
</p>
</aura:description>
<aura:example name="DataGrid" ref="c:DataGridImpl" label="DataGrid">
This example uses the default Data Grid Implementation
Expand Down

0 comments on commit fe6fec4

Please sign in to comment.