docs: add section on row click in DataTable (#11694)
* docs: add section on row click in DataTable * update subscriptions example
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
ab96ad3b82
commit
92514885e4
12 files changed
+10972
-10678
No files matched your search
@@ -16,15 +16,13 @@ This component is available after [Medusa v2.4.0+](https://github.com/medusajs/m
|
||||
|
||||
</Note>
|
||||
|
||||
The [DataTable component in Medusa UI](!ui!/components/data-table) allows you to display data in a table with sorting, filtering, and pagination.
|
||||
The [DataTable component in Medusa UI](!ui!/components/data-table) allows you to display data in a table with sorting, filtering, and pagination. It's used across the Medusa Admin dashboard to showcase a list of items, such as a list of products.
|
||||
|
||||
You can use this component in your Admin Extensions to display data in a table format, especially if they're retrieved from API routes of the Medusa application.
|
||||
|
||||
|
||||
<Note>
|
||||
You can use this component in your Admin Extensions to display data in a table format, especially if you're retrieving them from API routes of the Medusa application.
|
||||
|
||||
Refer to the [Medusa UI documentation](!ui!/components/data-table) for detailed information about the DataTable component and its different usages.
|
||||
|
||||
</Note>
|
||||
This guide focuses on how to use the `DataTable` component while fetching data from the backend. Refer to the [Medusa UI documentation](!ui!/components/data-table) for detailed information about the DataTable component and its different usages.
|
||||
|
||||
## Example: DataTable with Data Fetching
|
||||
|
||||
@@ -215,11 +213,14 @@ import {
|
||||
// ...
|
||||
useDataTable,
|
||||
} from "@medusajs/ui"
|
||||
import { useNavigate } from "react-router-dom"
|
||||
```
|
||||
|
||||
Then, replace the `TODO` in the component with the following:
|
||||
|
||||
```tsx title="src/admin/routes/custom/page.tsx"
|
||||
const navigate = useNavigate()
|
||||
|
||||
const table = useDataTable({
|
||||
columns,
|
||||
data: data?.products || [],
|
||||
@@ -244,6 +245,10 @@ const table = useDataTable({
|
||||
state: sorting,
|
||||
onSortingChange: setSorting,
|
||||
},
|
||||
onRowClick: (event, row) => {
|
||||
// Handle row click, for example
|
||||
navigate(`/products/${row.id}`)
|
||||
},
|
||||
})
|
||||
|
||||
// TODO render component
|
||||
@@ -251,24 +256,37 @@ const table = useDataTable({
|
||||
|
||||
The `useDataTable` hook accepts an object with the following properties:
|
||||
|
||||
- `columns`: The columns to display in the data table. You created this using the `createDataTableColumnHelper` utility.
|
||||
- `data`: The products fetched from the Medusa application.
|
||||
- `getRowId`: A function that returns the unique ID of a row.
|
||||
- `rowCount`: The total number of products that can be retrieved. This is used to determine the number of pages.
|
||||
- `isLoading`: A boolean that indicates if the data is being fetched.
|
||||
- `pagination`: An object to configure pagination. It accepts with the following properties:
|
||||
- `state`: The pagination React state variable.
|
||||
- `onPaginationChange`: A function that updates the pagination state.
|
||||
- `search`: An object to configure searching. It accepts the following properties:
|
||||
- `state`: The search query React state variable.
|
||||
- `onSearchChange`: A function that updates the search query state.
|
||||
- `filtering`: An object to configure filtering. It accepts the following properties:
|
||||
- `state`: The filtering React state variable.
|
||||
- `onFilteringChange`: A function that updates the filtering state.
|
||||
- `filters`: The filters to display in the data table. You created this using the `createDataTableFilterHelper` utility.
|
||||
- `sorting`: An object to configure sorting. It accepts the following properties:
|
||||
- `state`: The sorting React state variable.
|
||||
- `onSortingChange`: A function that updates the sorting state.
|
||||
<TypeList
|
||||
types={[
|
||||
{ name: "columns", type: "`array`", description: "The columns to display in the data table. You created this using the `createDataTableColumnHelper` utility." },
|
||||
{ name: "data", type: "`array`", description: "The products fetched from the Medusa application." },
|
||||
{ name: "getRowId", type: "`function`", description: "A function that returns the unique ID of a row." },
|
||||
{ name: "rowCount", type: "`number`", description: "The total number of products that can be retrieved. This is used to determine the number of pages." },
|
||||
{ name: "isLoading", type: "`boolean`", description: "A boolean that indicates if the data is being fetched." },
|
||||
{ name: "pagination", type: "`object`", description: "An object to configure pagination.", children: [
|
||||
{ name: "state", type: "`object`", description: "The pagination React state variable." },
|
||||
{ name: "onPaginationChange", type: "`function`", description: "A function that updates the pagination state." }
|
||||
]},
|
||||
{ name: "search", type: "`object`", description: "An object to configure searching.", children: [
|
||||
{ name: "state", type: "`string`", description: "The search query React state variable." },
|
||||
{ name: "onSearchChange", type: "`function`", description: "A function that updates the search query state." }
|
||||
]},
|
||||
{ name: "filtering", type: "`object`", description: "An object to configure filtering.", children: [
|
||||
{ name: "state", type: "`object`", description: "The filtering React state variable." },
|
||||
{ name: "onFilteringChange", type: "`function`", description: "A function that updates the filtering state." }
|
||||
]},
|
||||
{ name: "filters", type: "`array`", description: "The filters to display in the data table. You created this using the `createDataTableFilterHelper` utility." },
|
||||
{ name: "sorting", type: "`object`", description: "An object to configure sorting.", children: [
|
||||
{ name: "state", type: "`object`", description: "The sorting React state variable." },
|
||||
{ name: "onSortingChange", type: "`function`", description: "A function that updates the sorting state." }
|
||||
]},
|
||||
{ name: "onRowClick", type: "`function`", description: "A function that allows you to perform an action when the user clicks on a row. In this example, you navigate to the product's detail page.", children: [
|
||||
{ name: "event", type: "`mouseevent`", description: "An instance of the [MouseClickEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent) object." },
|
||||
{ name: "row", type: "`object`", description: "The data of the row that was clicked." }
|
||||
]}
|
||||
]}
|
||||
sectionTitle="Example: DataTable with Data Fetching"
|
||||
/>
|
||||
|
||||
Finally, you'll render the data table. But first, add the following imports at the top of the page:
|
||||
|
||||
|
||||
@@ -12,13 +12,11 @@ export const metadata = {
|
||||
|
||||
<Note>
|
||||
|
||||
If you're using [Medusa v2.4.0+](https://github.com/medusajs/medusa/releases/tag/v2.4.0), it's recommended to use the [Data Table](../data-table/page.mdx) component instead.
|
||||
If you're using [Medusa v2.4.0+](https://github.com/medusajs/medusa/releases/tag/v2.4.0), it's recommended to use the [Data Table](../data-table/page.mdx) component instead as it provides features for sorting, filtering, pagination, and more with a simpler API.
|
||||
|
||||
</Note>
|
||||
|
||||
The listing pages in the Admin show a table with pagination.
|
||||
|
||||
|
||||
You can use the `Table` component from Medusa UI to display data in a table. It's mostly recommended for simpler tables.
|
||||
|
||||
To create a component that shows a table with pagination, create the file `src/admin/components/table.tsx` with the following content:
|
||||
|
||||
|
||||
@@ -1459,8 +1459,8 @@ export const list1Highlights = [
|
||||
["23", "getStatusTitle", "Capitalize the status for the text shown in the status's badge."],
|
||||
["28", "columnHelper", "Prepare the column creation utility."],
|
||||
["30", "columns", "Define the columns for the data table."],
|
||||
["71", "SubscriptionsPage", "Define the component that shows the UI route's content."],
|
||||
["75", "config", "Export configurations to show the UI route in the sidebar."]
|
||||
["64", "SubscriptionsPage", "Define the component that shows the UI route's content."],
|
||||
["68", "config", "Export configurations to show the UI route in the sidebar."]
|
||||
]
|
||||
|
||||
```tsx title="src/admin/routes/subscriptions/page.tsx" highlights={list1Highlights} collapsibleLines="1-9" expandMoreLabel="Show Imports"
|
||||
@@ -1471,7 +1471,7 @@ import { useMemo, useState } from "react"
|
||||
import { SubscriptionData, SubscriptionStatus } from "../../types"
|
||||
import { useQuery } from "@tanstack/react-query"
|
||||
import { sdk } from "../../lib/sdk"
|
||||
import { Link } from "react-router-dom"
|
||||
import { useNavigate } from "react-router-dom"
|
||||
|
||||
const getBadgeColor = (status: SubscriptionStatus) => {
|
||||
switch(status) {
|
||||
@@ -1496,13 +1496,6 @@ const columnHelper = createDataTableColumnHelper<SubscriptionData>()
|
||||
const columns = [
|
||||
columnHelper.accessor("id", {
|
||||
header: "#",
|
||||
cell: ({ getValue }) => {
|
||||
return (
|
||||
<Link to={`/subscriptions/${getValue()}`}>
|
||||
{getValue()}
|
||||
</Link>
|
||||
)
|
||||
},
|
||||
}),
|
||||
columnHelper.accessor("metadata.main_order_id", {
|
||||
header: "Main Order",
|
||||
@@ -1558,6 +1551,7 @@ In the `SubscriptionsPage` component, you'll fetch the subscriptions and show th
|
||||
|
||||
```tsx title="src/admin/routes/subscriptions/page.tsx"
|
||||
const SubscriptionsPage = () => {
|
||||
const navigate = useNavigate()
|
||||
const [pagination, setPagination] = useState<DataTablePaginationState>({
|
||||
pageSize: 4,
|
||||
pageIndex: 0,
|
||||
@@ -1588,6 +1582,9 @@ const SubscriptionsPage = () => {
|
||||
state: pagination,
|
||||
onPaginationChange: setPagination,
|
||||
},
|
||||
onRowClick(event, row) {
|
||||
navigate(`/subscriptions/${row.id}`)
|
||||
},
|
||||
})
|
||||
|
||||
|
||||
@@ -1610,7 +1607,7 @@ In the component, you first initialize a `pagination` state variable of type `Da
|
||||
|
||||
Then, you use the `useQuery` hook from the `@tanstack/react-query` package to fetch the subscriptions. In the query function, you use the JS SDK to send a request to the `/admin/subscriptions` API route with the pagination query parameters.
|
||||
|
||||
Next, you use the `useDataTable` hook to create a data table instance. You pass the columns, subscriptions data, row count, loading state, and pagination settings to the hook.
|
||||
Next, you use the `useDataTable` hook to create a data table instance. You pass the columns, subscriptions data, row count, loading state, and pagination settings to the hook. You also navigate to the subscription details page when a row is clicked.
|
||||
|
||||
Finally, you render the data table with the subscriptions data, along with the pagination controls.
|
||||
|
||||
@@ -1687,7 +1684,7 @@ To test the UI routes, run the Medusa application and go to `http://localhost:90
|
||||
|
||||
After you log-in, you’ll find a new sidebar item “Subscriptions”. Once you click on it, you’ll see the list of subscription purchases.
|
||||
|
||||
To view a subscription’s details, click on its ID, which opens the subscription details page. This page contains the subscription’s orders.
|
||||
To view a subscription’s details, click on its row, which opens the subscription details page. This page contains the subscription’s orders.
|
||||
|
||||
### Further Reads
|
||||
|
||||
|
||||
Reference in new issue
Block a user