add filterFunc to model (#175)

* feat: add `FilterFunc` function

* feat: add ability to hide columns

* fix: removed `hidden` from branch

* fix: revert non-modified files

* fix: move per-column `filterFunc` to model level

* fix: improve documentation for `filterFunc`

* fix: pass filter input to `filterFunc`

* fix: either use standard row-matching or filterFunc but not both

* fix: updated docs

Author: trevorstarick

table/filter.go

@@ -14,8 +14,14 @@ func (m Model) getFilteredRows(rows []Row) []Row {
 	filteredRows := make([]Row, 0)
 
 	for _, row := range rows {
-		if isRowMatched(m.columns, row, filterInputValue) {
-			filteredRows = append(filteredRows, row)
+		if m.filterFunc != nil {
+			if m.filterFunc(row, filterInputValue) {
+				filteredRows = append(filteredRows, row)
+			}
+		} else {
+			if isRowMatched(m.columns, row, filterInputValue) {
+				filteredRows = append(filteredRows, row)
+			}
 		}
 	}
 

table/model.go

@@ -78,6 +78,7 @@ type Model struct {
 	// Filter
 	filtered        bool
 	filterTextInput textinput.Model
+	filterFunc      func(Row, string) bool
 
 	// For flex columns
 	targetTotalWidth int
@@ -125,6 +126,7 @@ func New(columns []Column) Model {
 		unselectedText: "[ ]",
 
 		filterTextInput: filterInput,
+		filterFunc:      nil,
 		baseStyle:       lipgloss.NewStyle().Align(lipgloss.Right),
 
 		paginationWrapping: true,

table/options.go

@@ -364,6 +364,16 @@ func (m Model) WithFilterInputValue(value string) Model {
 	return m
 }
 
+// WithFilterFunc adds a filter function to the model. If the function returns
+// true, the row will be included in the filtered results. If the function
+// is nil, the function won't be used. The filter input is passed as the second
+// argument to the function.
+func (m Model) WithFilterFunc(shouldInclude func(row Row, filterInput string) bool) Model {
+	m.filterFunc = shouldInclude
+
+	return m
+}
+
 // WithFooterVisibility sets the visibility of the footer.
 func (m Model) WithFooterVisibility(visibility bool) Model {
 	m.footerVisible = visibility