Supabase Grid
A react component to display your Postgresql table data.
Install
npm i @supabase/grid
This package requires some peer dependencies, which you need to install by yourself.
npm i react react-dom @supabase/react-data-grid @supabase/ui
Usage
<SupabaseGrid
table="countries"
onSqlQuery={async (query: string) => {
// run query and return the result
}}
/>
Properties
Required
-
table
SupaTable object or table/view name.- readonly mode: support both table and view
- editable mode: only for table
-
onSqlQuery
run sql query.
Optional
-
editable
enable table editor. -
headerActions
react node to display in grid header. -
gridProps
props to config grid view. -
schema
table/view schema. Defaults to 'public'. -
storageRef
storageRef is used to save state on localstorage. -
theme
grid theme. -
onAddColumn
show create new column button if available. -
onAddRow
show add row button if available. -
onError
error handler. -
onEditColumn
show edit column menu if available. -
onEditRow
show edit row button if available. -
onDeleteColumn
show delete column menu if available.
Run example
- Build library:
npm start
- Go to example folder:
cd example
- Create .env file:
cp .env.example .env
- Update example/.env file with your Supabase project settings
- Run example app:
npm start
Contributing
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes and merge
License
This repo is licensed under MIT.