Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(admin-ui): Use generics in ReactDataTableComponentProps #2500

Merged
merged 2 commits into from
Nov 3, 2023
Merged

refactor(admin-ui): Use generics in ReactDataTableComponentProps #2500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfcd6d4
refactor(admin-ui): Use generics in ReactDataTableComponentProps
barakamwakisha Oct 31, 2023
54cf336
refactor(admin-ui): Use any as default generic value in ReactDataTabl…
barakamwakisha Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/guides/extending-the-admin-ui/custom-data-table-components/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ React components will receive the value of the current column as the `rowItem` p
import { ReactDataTableComponentProps } from '@vendure/admin-ui/react';
import React from 'react';

export function SlugLink({ rowItem }: ReactDataTableComponentProps) {
const slug: string = rowItem.slug;
export function SlugLink({ rowItem }: ReactDataTableComponentProps<{ slug: string }>) {
const slug = rowItem.slug;
return (
<a href={`https://example.com/category/${slug}`} target="_blank">
{slug}
Expand Down
2 changes: 1 addition & 1 deletion .../reference/admin-ui-api/react-extensions/register-react-data-table-component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ e.g. the `Product` object if used in the `product-list` table.
import { ReactDataTableComponentProps } from '@vendure/admin-ui/react';
import React from 'react';

export function SlugWithLink({ rowItem }: ReactDataTableComponentProps) {
export function SlugWithLink({ rowItem }: ReactDataTableComponentProps<{ slug: string }>) {
return (
<a href={`https://example.com/products/${rowItem.slug}`} target="_blank">
{rowItem.slug}
Expand Down
8 changes: 4 additions & 4 deletions packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ export interface ReactDataTableComponentConfig {
* @description
* The props that will be passed to the React component registered via {@link registerReactDataTableComponent}.
*/
export interface ReactDataTableComponentProps {
rowItem: any;
export interface ReactDataTableComponentProps<T = any> {
rowItem: T;
[prop: string]: any;
}

Expand All @@ -60,7 +60,7 @@ export interface ReactDataTableComponentProps {
* import { ReactDataTableComponentProps } from '\@vendure/admin-ui/react';
* import React from 'react';
*
* export function SlugWithLink({ rowItem }: ReactDataTableComponentProps) {
* export function SlugWithLink({ rowItem }: ReactDataTableComponentProps<{ slug: string }>) {
* return (
* <a href={`https://example.com/products/${rowItem.slug}`} target="_blank">
* {rowItem.slug}
Expand All @@ -79,7 +79,7 @@ export interface ReactDataTableComponentProps {
* tableId: 'product-list',
* columnId: 'slug',
* props: {
* foo: 'bar',
* foo: 'bar',
* },
* }),
* ];
Expand Down
4 changes: 2 additions & 2 deletions packages/dev-server/test-plugins/experimental-ui/components/SlugWithLink.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { ReactDataTableComponentProps } from '@vendure/admin-ui/react';
import React from 'react';

export function SlugWithLink({ rowItem }: ReactDataTableComponentProps) {
const slug: string = rowItem.slug;
export function SlugWithLink({ rowItem }: ReactDataTableComponentProps<{ slug: string }>) {
const slug = rowItem.slug;
return (
<a href={`https://example.com/category/${slug}`} target="_blank">
{slug}
Expand Down
Loading