jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update search-and-filter.md (#449)

Browse Source 
Summary:
Fix some minor typos.
Pull Request resolved: https://github.com/facebook/flipper/pull/449

Reviewed By: danielbuechele

Differential Revision: D15371603

Pulled By: passy

fbshipit-source-id: a64a64039a9275d9b8fce82cb06cec0627bb9af8
This commit is contained in:
Pascal Hartig
2019-05-16 04:18:21 -07:00
committed by Facebook Github Bot
parent 94231670f8
commit 2aabfd98e4
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/extending/search-and-filter.md
View File

@@ -3,12 +3,12 @@ id: search-and-filter
title: Searching and Filtering title: Searching and Filtering
--- ---
Many plugins need the ability to make their content search and filterable. Flipper provides a component for this use-case called `Searchable`. This is a higher-order-component that can be used to wrap any table, list, generic react-component and adds Flippers search bar on top of it. Many plugins need the ability to make their content searchable and filterable. Flipper provides a component for this use-case called `Searchable`. This is a higher-order-component that can be used to wrap any table, list, or generic React component and adds Flipper's search bar on top of it.
We differentiate between search and filter, but both functionalities are provided by the `Searchable` component. Search is a custom string entered by the user. Filters can not be added by the user directly, but are added programmatically from within your plugin. We differentiate between search and filter, but both functionalities are provided by the `Searchable` component. Search is a custom string entered by the user. Filters cannot be added by the user directly, but are added programmatically from within your plugin.
## Filters ## Filters
Every filter has a key and a value. The key represents an attribute of the items you are filtering, and the value is the value that is compared with the items to see if the attribute matches. As an example, if you were filtering rows of a table, the a filter key would be the id of a column. Every filter has a key and a value. The key represents an attribute of the items you are filtering, and the value is the value that is compared with the items to see if the attribute matches. As an example, if you were filtering rows of a table, a filter key would be the id of a column.
There are two different types of filters: There are two different types of filters:
- **include/exclude filters**: An arbitrary string that must (or must not) be included in the filterable item. - **include/exclude filters**: An arbitrary string that must (or must not) be included in the filterable item.
@@ -23,7 +23,7 @@ Function allowing the component to add filters.
`searchTerm: string` `searchTerm: string`
The search term entered into the searchbar by the user. The search term entered into the search bar by the user.
`filters: Array<Filter>` `filters: Array<Filter>`