{"action":"created","issue":{"url":"https://api.github.com/repos/AllenFang/react-bootstrap-table/issues/940","repository_url":"https://api.github.com/repos/AllenFang/react-bootstrap-table","labels_url":"https://api.github.com/repos/AllenFang/react-bootstrap-table/issues/940/labels{/name}","comments_url":"https://api.github.com/repos/AllenFang/react-bootstrap-table/issues/940/comments","events_url":"https://api.github.com/repos/AllenFang/react-bootstrap-table/issues/940/events","html_url":"https://github.com/AllenFang/react-bootstrap-table/issues/940","id":198988982,"number":940,"title":"Clarity of `filterFormatted` in Documentation","user":{"login":"alanqthomas","id":5376488,"avatar_url":"https://avatars.githubusercontent.com/u/5376488?v=3","gravatar_id":"","url":"https://api.github.com/users/alanqthomas","html_url":"https://github.com/alanqthomas","followers_url":"https://api.github.com/users/alanqthomas/followers","following_url":"https://api.github.com/users/alanqthomas/following{/other_user}","gists_url":"https://api.github.com/users/alanqthomas/gists{/gist_id}","starred_url":"https://api.github.com/users/alanqthomas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alanqthomas/subscriptions","organizations_url":"https://api.github.com/users/alanqthomas/orgs","repos_url":"https://api.github.com/users/alanqthomas/repos","events_url":"https://api.github.com/users/alanqthomas/events{/privacy}","received_events_url":"https://api.github.com/users/alanqthomas/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2017-01-05T15:55:36Z","updated_at":"2017-01-07T06:12:18Z","closed_at":null,"body":"## Issue\r\nThe `filterFormatted` prop has an unclear description in the documentation. I spent hours trying to figure out why my select filter wouldn't work. It turns out I had included `filterFormatted` in the column (because of the [examples for the select filter](http://allenfang.github.io/react-bootstrap-table/example.html#column-filter)) without fully understanding what it did. Looking at the documentation it seemed like I just needed to include it in the column to enable filtering. \r\n\r\n## Proposed fix\r\nMake the documentation for `filterFormatted` clearer. To get started in the right direction, I'd suggest something as follows.\r\n\r\n> When true, the column will filter using the value returned by the column's formatter. When false (default), the column will filter using the pre-formatted value.\r\n\r\nAlso consider changing the [filter examples](http://allenfang.github.io/react-bootstrap-table/example.html#column-filter) to not include `filterFormatted` and possibly include one extra example to showcase the use of `filterFormatted` explicitly.\r\n\r\nAnyways, thanks to everyone who's worked on this component. It's extremely powerful and versatile. "},"comment":{"url":"https://api.github.com/repos/AllenFang/react-bootstrap-table/issues/comments/271065937","html_url":"https://github.com/AllenFang/react-bootstrap-table/issues/940#issuecomment-271065937","issue_url":"https://api.github.com/repos/AllenFang/react-bootstrap-table/issues/940","id":271065937,"user":{"login":"AllenFang","id":5351390,"avatar_url":"https://avatars.githubusercontent.com/u/5351390?v=3","gravatar_id":"","url":"https://api.github.com/users/AllenFang","html_url":"https://github.com/AllenFang","followers_url":"https://api.github.com/users/AllenFang/followers","following_url":"https://api.github.com/users/AllenFang/following{/other_user}","gists_url":"https://api.github.com/users/AllenFang/gists{/gist_id}","starred_url":"https://api.github.com/users/AllenFang/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AllenFang/subscriptions","organizations_url":"https://api.github.com/users/AllenFang/orgs","repos_url":"https://api.github.com/users/AllenFang/repos","events_url":"https://api.github.com/users/AllenFang/events{/privacy}","received_events_url":"https://api.github.com/users/AllenFang/received_events","type":"User","site_admin":false},"created_at":"2017-01-07T06:12:18Z","updated_at":"2017-01-07T06:12:18Z","body":"@alanqthomas, that's awesome explain for ```filterFormatted``` and I think [filter examples](http://allenfang.github.io/react-bootstrap-table/example.html#column-filter) is not very clear for I dont show you the source data which cause you cant understand what's happen in ```enumFormatter```.\r\n\r\nAnyway,  ```filterFormatted``` can be used on filter and search, for the purpose of ```filterFormatted``` is for filtering the formatted data(Which means you want to filter the data that you define on the ```dataFormat```).\r\n\r\nI'll fix the document quickly, thanks your suggestion, It's very helpful."}}
{"actor":{"display_login":"AllenFang"}}