From b34718ac32e78be3e8fd72256ecc7a411dcdb332 Mon Sep 17 00:00:00 2001
From: Andrey Goncharov <aigoncharov@meta.com>
Date: Wed, 15 Nov 2023 05:00:21 -0800
Subject: [PATCH] Extend docs

Reviewed By: antonk52

Differential Revision: D51305961

fbshipit-source-id: a4ca7365def6ebf43b84668f63887cc81f82fb36
---
 docs/extending/power-search.mdx | 95 ++++++++++++++++++++++++++++++++-
 1 file changed, 94 insertions(+), 1 deletion(-)

diff --git a/docs/extending/power-search.mdx b/docs/extending/power-search.mdx
index 5b424a5f0..5fed042f0 100644
--- a/docs/extending/power-search.mdx
+++ b/docs/extending/power-search.mdx
@@ -8,6 +8,99 @@ By default, your [table](../tutorial/js-table.mdx) has a power search bar. It al
 For instance, for string values it can check if a string contains a substring or even matches some other string exactly. At the same time, for dates Flipper can filter out records after or before a certain date.
 Since Flipper does not have a way of identifying the column type in advance, it always assumes that every column is a string. If you want you can tell Flipper how to handle a column and what power search operators should be available.
 
-You can see a live example of how you can provide the power search config [here](https://fburl.com/code/rrxj86e5). 
+## Simplified config
+
+Power search provides a list of default predicates for every column data type. You can specify the column data type like this:
+
+```tsx
+import {DataTableColumn} from 'flipper-plugin'
+
+type MyRow = {
+    timestamp: number;
+    eventType: string;
+}
+
+const columns: DataTableColumn<MyRow>[] = [
+    {
+      key: 'timestamp',
+      title: 'Timestamp',
+      sortable: true,
+      powerSearchConfig: {type: 'dateTime'},
+    },
+    {
+        key: 'eventType',
+        title: 'Event',
+        powerSearchConfig: {type: 'enum'}
+    },
+]
+```
+
+[Complete list of possible "types"](https://github.com/facebook/flipper/blob/main/desktop/flipper-plugin/src/ui/data-table/DataTableWithPowerSearch.tsx#L148).
+
+## Advanced config
+
+If the default list of predicates is not tailored enouhg for your use-case, you can provide a list of predicates explicitly.
+
+```tsx
+import {DataTableColumn, dataTablePowerSearchOperators} from 'flipper-plugin'
+
+type MyRow = {
+    timestamp: number;
+    eventType: string;
+}
+
+const EVENT_TYPE_ENUM_LABELS = {
+    yodaValue: 'Yoda Label',
+    lukeValue: 'Luke Label'
+}
+
+const columns: DataTableColumn<MyRow>[] = [
+    {
+      key: 'timestamp',
+      title: 'Timestamp',
+      sortable: true,
+      powerSearchConfig: [
+        dataTablePowerSearchOperators.same_as_absolute_date_no_time(),
+      ]
+    },
+    {
+        key: 'eventType',
+        title: 'Event',
+        powerSearchConfig: {   
+            // You can also provide power search config as an object
+            operators: [
+                dataTablePowerSearchOperators.enum_is(EVENT_TYPE_ENUM_LABELS),
+                dataTablePowerSearchOperators.enum_is_not(EVENT_TYPE_ENUM_LABELS),
+            ],
+            // It could have exra options
+            // See https://github.com/facebook/flipper/blob/main/desktop/flipper-plugin/src/ui/data-table/DataTableWithPowerSearch.tsx#L157
+        }
+    },
+]
+```
+
+## Using legacy search
+
+While we would encourage using the new power search, some plugins might decide to stick to the legacy experience. To do that you have to use different imports from 'flipper-plugin': `MasterDetailLegacy` instead of `MasterDetail`, `DataTableLegacy` instead of `DataTable`, `DataTableColumnLegacy` instead of `DataTable`, `DataTableManagerLegacy` instead of `DataTableManager`.
+
+```tsx
+import {MasterDetailLegacy, DataTableColumnLegacy} from 'flipper-plugin';
+
+const columns: DataTableColumnLegacy<MyRow>[] = [
+    // colun definition
+]
+
+export const Component = () => {
+    return <MasterDetailLegacy columns={columns} /* ...other props */ />
+}
+```
+
+## Examples 
+
+You can see a live examplse of how you can provide the power search config here:
+
+0. [Logs](https://github.com/facebook/flipper/blob/main/desktop/plugins/public/logs/index.tsx#L49)
+0. [Network](https://github.com/facebook/flipper/blob/main/desktop/plugins/public/network/index.tsx#L664)
+0. [Intern-only](https://fburl.com/code/liiu1wns). 
 
 You can find the complete list of supported operators [here](https://github.com/facebook/flipper/blob/main/desktop/flipper-plugin/src/ui/data-table/DataTableDefaultPowerSearchOperators.tsx).