• Deutsch

      • Component-Entwicklung

      In NocoBase sind die in der Route eingebundenen Seitencomponents gewöhnliche React Components. Sie können diese direkt mit React + Antd schreiben — das unterscheidet sich nicht von gewöhnlicher Frontend-Entwicklung.

      NocoBase stellt zusätzlich folgende Hilfsmittel bereit:

      • observable + observer — die empfohlene Art der Zustandsverwaltung, besser geeignet für das NocoBase-Ökosystem als useState
      • useFlowContext() — Zugriff auf die Kontextfähigkeiten von NocoBase (Anfragen senden, Internationalisierung, Routennavigation usw.)

      Grundlegende Schreibweise

      Ein einfachstes Seitencomponent:

      // pages/HelloPage.tsx
export default function HelloPage() {
  return <h1>Hello, NocoBase!</h1>;
}

      Nach dem Schreiben registrieren Sie es im load() des Plugins über this.router.add(). Details siehe Router.

      Zustandsverwaltung: observable

      NocoBase empfiehlt, statt Reacts useState observable + observer zur Zustandsverwaltung von Components zu verwenden. Vorteile:

      • Direkte Änderungen an Objekteigenschaften lösen Aktualisierungen aus, kein setState nötig
      • Automatische Abhängigkeitsverfolgung, das Component rendert nur dann erneut, wenn tatsächlich verwendete Eigenschaften sich ändern
      • Konsistent mit dem Reaktivitätsmechanismus der NocoBase-Basis (FlowModel, FlowContext usw.)

      Grundlegende Verwendung: Erstellen Sie ein reaktives Objekt mit observable.deep() und umhüllen Sie das Component mit observer(). Sowohl observable als auch observer werden aus @nocobase/flow-engine importiert:

      import React from 'react';
import { Input } from 'antd';
import { observable, observer } from '@nocobase/flow-engine';

// Ein reaktives Zustandsobjekt erstellen
const state = observable.deep({
  text: '',
});

// Component mit observer umhüllen, wird automatisch bei Zustandsänderungen aktualisiert
const DemoPage = observer(() => {
  return (
    <div>
      <Input
        placeholder="Geben Sie etwas ein..."
        value={state.text}
        onChange={(e) => {
          state.text = e.target.value;
        }}
      />
      {state.text && <div style={{ marginTop: 8 }}>Sie haben eingegeben: {state.text}</div>}
    </div>
  );
});

export default DemoPage;

      Live-Vorschau:

      import { Application, Plugin } from '@nocobase/client-v2';

class MyPlugin extends Plugin {
  async load() {
    this.router.add('root', {
      path: '/',
      componentLoader: () => import('@docs/cn/plugin-development/client/component/_demos/observable-basic-page'),
    });
  }
}

// 下面的代码只是为了让这个 demo 能在文档中独立运行，实际开发插件时无需关注 app 的实例化。
const app = new Application({
  // 代码示例里用了 memory router，实际项目里用户无需关注这个，app 实例化由 Nocobase 内部完成。
  router: { type: 'memory', initialEntries: ['/'] },
  plugins: [MyPlugin],
});

export default app.getRootComponent();

      Mehr zur Verwendung siehe Reaktivitätsmechanismus Observable.

      useFlowContext verwenden

      useFlowContext() ist der Einstiegspunkt zu den NocoBase-Fähigkeiten. Es wird aus @nocobase/flow-engine importiert und gibt ein ctx-Objekt zurück:

      import { useFlowContext } from '@nocobase/flow-engine';

export default function MyPage() {
  const ctx = useFlowContext();
  // ctx.api — Anfragen senden
  // ctx.t — Internationalisierung
  // ctx.router — Routennavigation
  // ctx.logger — Logging
  // ...
}

      Im Folgenden Beispiele für häufig verwendete Fähigkeiten.

      Anfragen senden

      Über ctx.api.request() rufen Sie Backend-Schnittstellen auf, die Verwendung entspricht Axios:

      const response = await ctx.api.request({
  url: 'users:list',
  method: 'get',
});
console.log(response.data);

      Internationalisierung

      Über ctx.t() erhalten Sie übersetzte Texte:

      const label = ctx.t('Hello');
// Mit Namespace
const msg = ctx.t('Save success', { ns: '@my-project/plugin-hello' });

      Routennavigation

      Über ctx.router.navigate() zu einer anderen Seite navigieren:

      ctx.router.navigate('/some-page'); // -> /v/some-page

      Aktuelle Routenparameter abrufen:

      // Beispielsweise mit der Route /users/:id
const { id } = ctx.route.params; // Dynamischen Parameter holen

      Aktuellen Routennamen abrufen:

      const { name } = ctx.route; // Routennamen holen

      Mehr zu Log-Levels und Verwendung siehe Context → Häufige Fähigkeiten.

      Vollständiges Beispiel

      Eine Seite, die observable, useFlowContext und Antd kombiniert und Daten vom Backend abruft und anzeigt:

      // pages/PostListPage.tsx
import React, { useEffect } from 'react';
import { Button, Card, List, Spin } from 'antd';
import { observable, observer, FlowContext, useFlowContext } from '@nocobase/flow-engine';

interface Post {
  id: number;
  title: string;
}

// Seitenzustand mit observable verwalten
const state = observable.deep({
  posts: [] as Post[],
  loading: true,
});

const PostListPage = observer(() => {
  const ctx = useFlowContext();

  useEffect(() => {
    loadPosts(ctx);
  }, []);

  return (
    <Card title={ctx.t('Post list')}>
      <Spin spinning={state.loading}>
        <List
          dataSource={state.posts}
          renderItem={(post: Post) => (
            <List.Item
              actions={[
                <Button danger onClick={() => handleDelete(ctx, post.id)}>
                  {ctx.t('Delete')}
                </Button>,
              ]}
            >
              {post.title}
            </List.Item>
          )}
        />
      </Spin>
    </Card>
  );
});

async function loadPosts(ctx: FlowContext) {
  state.loading = true;
  try {
    const response = await ctx.api.request({
      url: 'posts:list',
      method: 'get',
    });
    state.posts = response.data?.data || [];
  } catch (error) {
    ctx.logger.error('Beitragsliste konnte nicht geladen werden', { error });
  } finally {
    state.loading = false;
  }
}

async function handleDelete(ctx: FlowContext, id: number) {
  await ctx.api.request({
    url: `posts:destroy/${id}`,
    method: 'post',
  });
  loadPosts(ctx); // Liste aktualisieren
}

export default PostListPage;

      Wie geht es weiter

      • Vollständige Fähigkeiten von useFlowContext — siehe Context
      • Component-Styles und Theme-Anpassung — siehe Styles & Themes
      • Wenn Ihr Component im Menü „Block / Feld / Aktion hinzufügen" von NocoBase erscheinen und vom Benutzer visuell konfigurierbar sein muss, verpacken Sie es mit einem FlowModel — siehe FlowEngine
      • Unsicher, ob Component oder FlowModel verwenden? — siehe Component vs FlowModel