Skip to content

@sqlrooms/data-table / DataTableModal

Function: DataTableModal()

DataTableModal(props): ReactNode | Promise<ReactNode>

A modal component for displaying a table with data from a SQL query.

Parameters

ParameterTypeDescription
props{ className: string; title: undefined | string; query: undefined | string; tableModal: Pick<UseDisclosureReturnValue, "isOpen" | "onClose">; }Component props
props.className?string-
props.titleundefined | stringThe title of the table
props.queryundefined | stringThe SQL query to execute and display in the table
props.tableModalPick<UseDisclosureReturnValue, "isOpen" | "onClose">An object containing the modal's open state and close function

Returns

ReactNode | Promise<ReactNode>

Component

Example

tsx
import { useState } from 'react';
import { DataTableModal } from '@sqlrooms/data-table';

const MyComponent = () => {
  const tableModal = useDisclosure();
  return (
    <DataTableModal
      title="Users"
      query="SELECT * FROM users LIMIT 10"
      tableModal={tableModal}
    />
  );
};