Provide standardised MasterDetail

Summary:
Noticed in reviews during the convertathon there is still quite some boilerplate in things that happen on the boundary of UI and plugin state, such as setting up menu entries and providing common functionality like clear, master/detail layout, etc.

This diff introduces the `MasterDetail` component, which takes a higher level approach by merely needing to provide the state atoms and desired features, and taking care of the wiring.

Applied it to createTablePlugin, to prove that going from `createTablePlugin` to `MasterDetail` will be a much smaller step now.

Verified on the funnel logger plugin

Reviewed By: passy

Differential Revision: D28090362

fbshipit-source-id: 146f8c315fea903901ad4e3e46711642f16cf0e6
This commit is contained in:
Michel Weststrate
2021-04-29 07:30:56 -07:00
committed by Facebook GitHub Bot
parent e7cdbcbe85
commit e26a8c5ad0
9 changed files with 347 additions and 126 deletions

View File

@@ -7,31 +7,14 @@
* @format
*/
import {
DeleteOutlined,
PauseCircleOutlined,
PlayCircleOutlined,
} from '@ant-design/icons';
import {Button, notification, Typography} from 'antd';
import React, {createRef, useCallback} from 'react';
import {notification, Typography} from 'antd';
import React from 'react';
import {PluginClient} from '../plugin/Plugin';
import {usePlugin} from '../plugin/PluginContext';
import {createState, useValue} from '../state/atom';
import {createState} from '../state/atom';
import {createDataSource, DataSource} from '../state/DataSource';
import {DataInspector} from '../ui/data-inspector/DataInspector';
import {DataTable, DataTableColumn} from '../ui/data-table/DataTable';
import {DataTableManager} from '../ui/data-table/DataTableManager';
import {DetailSidebar} from '../ui/DetailSidebar';
import {Layout} from '../ui/Layout';
import {Panel} from '../ui/Panel';
function defaultRenderSidebar<T>(record: T) {
return (
<Panel title="Payload" collapsible={false} pad>
<DataInspector data={record} expandRoot />
</Panel>
);
}
import {DataTableColumn} from '../ui/data-table/DataTable';
import {MasterDetail} from '../ui/MasterDetail';
type PluginResult<Raw, Row> = {
plugin(
@@ -95,7 +78,6 @@ export function createTablePlugin<
});
const selection = createState<undefined | Row>(undefined);
const isPaused = createState(false);
const tableManagerRef = createRef<undefined | DataTableManager<Row>>();
client.onMessage(props.method, (event) => {
if (isPaused.get()) {
@@ -113,7 +95,7 @@ export function createTablePlugin<
if (props.resetMethod) {
client.onMessage(props.resetMethod, () => {
clear();
rows.clear();
});
}
@@ -134,94 +116,29 @@ export function createTablePlugin<
});
});
client.addMenuEntry(
{
action: 'clear',
handler: clear,
},
{
action: 'createPaste',
handler: createPaste,
},
{
action: 'goToBottom',
handler: goToBottom,
},
);
function clear() {
rows.clear();
tableManagerRef.current?.clearSelection();
}
function createPaste() {
let selection = tableManagerRef.current?.getSelectedItems();
if (!selection?.length) {
selection = rows.view.output(0, rows.view.size);
}
if (selection?.length) {
client.createPaste(JSON.stringify(selection, null, 2));
}
}
function goToBottom() {
tableManagerRef?.current?.selectItem(rows.view.size - 1);
}
return {
selection,
rows,
clear,
tableManagerRef,
connected: client.connected,
isPaused,
resumePause() {
isPaused.update((v) => !v);
},
};
}
function SidebarComponent({record}: {record: Row}) {
return props.renderSidebar!(record);
}
function Component() {
const instance = usePlugin(plugin);
const paused = useValue(instance.isPaused);
const selection = useValue(instance.selection);
const connected = useValue(instance.connected);
const handleSelect = useCallback((v) => instance.selection.set(v), [
instance,
]);
return (
<Layout.Container grow>
<DataTable<Row>
columns={props.columns}
dataSource={instance.rows}
tableManagerRef={instance.tableManagerRef}
autoScroll
onSelect={handleSelect}
extraActions={
connected ? (
<>
<Button
title={`Click to ${paused ? 'resume' : 'pause'} the stream`}
danger={paused}
onClick={instance.resumePause}>
{paused ? <PlayCircleOutlined /> : <PauseCircleOutlined />}
</Button>
<Button title="Clear records" onClick={instance.clear}>
<DeleteOutlined />
</Button>
</>
) : undefined
}
/>
<DetailSidebar>
{selection
? props.renderSidebar?.(selection) ??
defaultRenderSidebar(selection)
: null}
</DetailSidebar>
</Layout.Container>
<MasterDetail<Row>
columns={props.columns}
dataSource={instance.rows}
sidebarComponent={props.renderSidebar ? SidebarComponent : undefined}
selection={instance.selection}
isPaused={instance.isPaused}
enableMenuEntries
enableClear
/>
);
}