Skip to content

Pinelab-studio/pinelab-vendure-plugins / .agents/skills

migrating-vendure-admin-ui-to-react-dashboard

Verified

Migrates Vendure Admin UI extensions (legacy Angular-based) to the new React Dashboard.

FileKindSize
01-general.mdmarkdown6.0 KB
01a-common-tasks.mdmarkdown1.1 KB
01b-tsconfig-setup.mdmarkdown1.5 KB
01c-common-pitfalls.mdmarkdown3.9 KB
02-forms.mdmarkdown1.5 KB
03-custom-field-inputs.mdmarkdown3.6 KB
04-list-pages.mdmarkdown8.7 KB
05-detail-pages.mdmarkdown10.5 KB
06-adding-nav-menu-items.mdmarkdown1.1 KB
07-action-bar-items.mdmarkdown983 B
08-custom-detail-components.mdmarkdown2.2 KB
09-page-tabs.mdmarkdown481 B
10-widgets.mdmarkdown2.8 KB
SKILL.mdskill md1.0 KB

10-widgets.md

View on GitHub
## Widgets

### Old (Angular)

```ts title="src/plugins/reviews/ui/components/reviews-widget/reviews-widget.component.ts"
import { Component, OnInit } from '@angular/core';
import { DataService, SharedModule } from '@vendure/admin-ui/core';
import { Observable } from 'rxjs';

@Component({
  selector: 'reviews-widget',
  template: `
    <ul>
      <li *ngFor="let review of pendingReviews$ | async">
        <a [routerLink]="['/extensions', 'product-reviews', review.id]">{{
          review.summary
        }}</a>
        <span class="rating">{{ review.rating }} / 5</span>
      </li>
    </ul>
  `,
  standalone: true,
  imports: [SharedModule],
})
export class ReviewsWidgetComponent implements OnInit {
  pendingReviews$: Observable<any[]>;

  constructor(private dataService: DataService) {}

  ngOnInit() {
    this.pendingReviews$ = this.dataService
      .query(
        gql`
          query GetAllReviews($options: ProductReviewListOptions) {
            productReviews(options: $options) {
              items {
                id
                createdAt
                authorName
                summary
                rating
              }
            }
          }
        `,
        {
          options: {
            filter: { state: { eq: 'new' } },
            take: 10,
          },
        }
      )
      .mapStream((data) => data.productReviews.items);
  }
}
```

```ts title="src/plugins/reviews/ui/providers.ts"
import { registerDashboardWidget } from '@vendure/admin-ui/core';

export default [
  registerDashboardWidget('reviews', {
    title: 'Latest reviews',
    supportedWidths: [4, 6, 8, 12],
    requiresPermissions: ['ReadReview'],
    loadComponent: () =>
      import('./reviews-widget/reviews-widget.component').then(
        (m) => m.ReviewsWidgetComponent
      ),
  }),
];
```

### New (React Dashboard)

```tsx title="custom-widget.tsx"
import {
  Badge,
  DashboardBaseWidget,
  useLocalFormat,
  useWidgetFilters,
} from '@vendure/dashboard';

export function CustomWidget() {
  const { dateRange } = useWidgetFilters();
  const { formatDate } = useLocalFormat();
  return (
    <DashboardBaseWidget
      id="custom-widget"
      title="Custom Widget"
      description="This is a custom widget"
    >
      <div className="flex flex-wrap gap-1">
        <span>Displaying results from</span>
        <Badge variant="secondary">{formatDate(dateRange.from)}</Badge>
        <span>to</span>
        <Badge variant="secondary">{formatDate(dateRange.to)}</Badge>
      </div>
    </DashboardBaseWidget>
  );
}
```

```tsx title="index.tsx"
import { defineDashboardExtension } from '@vendure/dashboard';

import { CustomWidget } from './custom-widget';

defineDashboardExtension({
  widgets: [
    {
      id: 'custom-widget',
      name: 'Custom Widget',
      component: CustomWidget,
      defaultSize: { w: 3, h: 3 },
    },
  ],
});
```
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall