• Português

      • Desenvolvimento de Component

      No NocoBase, os componentes de página montados nas rotas são componentes React comuns. Você pode escrevê-los diretamente com React + Antd, sem diferença em relação ao desenvolvimento front-end comum.

      Adicionalmente, o NocoBase fornece:

      • observable + observer — forma recomendada de gerenciar estado, mais adequada ao ecossistema NocoBase do que useState
      • useFlowContext() — obtém as capacidades do contexto NocoBase (envio de requisições, internacionalização, navegação por rotas etc.)

      Forma básica

      Um componente de página simples:

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

      Após escrevê-lo, registre-o no load() do plugin com this.router.add(). Veja Router de rotas para mais detalhes.

      Gerenciamento de estado: observable

      O NocoBase recomenda usar observable + observer para gerenciar o estado dos componentes em vez do useState do React. As vantagens são:

      • Modificar diretamente as propriedades do objeto já dispara a atualização, sem precisar de setState
      • Coleta de dependências automática; o componente só renderiza novamente quando uma propriedade utilizada muda
      • É consistente com o mecanismo reativo da camada base do NocoBase (FlowModel, FlowContext etc.)

      Uso básico: crie um objeto reativo com observable.deep() e envolva o componente com observer(). Tanto observable quanto observer são importados de @nocobase/flow-engine:

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

// 创建一个响应式状态对象
const state = observable.deep({
  text: '',
});

// 用 observer 包裹组件，状态变化时自动更新
const DemoPage = observer(() => {
  return (
    <div>
      <Input
        placeholder="输入点什么..."
        value={state.text}
        onChange={(e) => {
          state.text = e.target.value;
        }}
      />
      {state.text && <div style={{ marginTop: 8 }}>你输入了：{state.text}</div>}
    </div>
  );
});

export default DemoPage;

      Pré-visualização do resultado:

      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();

      Para mais detalhes, veja Mecanismo reativo Observable.

      Usando useFlowContext

      useFlowContext() é o ponto de entrada para conectar com as capacidades do NocoBase. Importe-o de @nocobase/flow-engine. Ele retorna um objeto ctx:

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

export default function MyPage() {
  const ctx = useFlowContext();
  // ctx.api — 发请求
  // ctx.t — 国际化
  // ctx.router — 路由导航
  // ctx.logger — 日志
  // ...
}

      A seguir, exemplos das capacidades mais comuns.

      Envio de requisições

      Use ctx.api.request() para chamar APIs do backend, com uso semelhante ao do Axios:

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

      Internacionalização

      Use ctx.t() para obter o texto traduzido:

      const label = ctx.t('Hello');
// 指定命名空间
const msg = ctx.t('Save success', { ns: '@my-project/plugin-hello' });

      Use ctx.router.navigate() para navegar entre páginas:

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

      Obter os parâmetros da rota atual:

      // 比如路由定义为 /users/:id
const { id } = ctx.route.params; // 获取动态参数

      Obter o nome da rota atual:

      const { name } = ctx.route; // 获取路由名字

      Para mais níveis de log e formas de uso, veja Context → Capacidades comuns.

      Exemplo completo

      Combinando observable, useFlowContext e Antd, um componente de página que busca e exibe dados do backend:

      // 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;
}

// 用 observable 管理页面状态
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('加载文章列表失败', { error });
  } finally {
    state.loading = false;
  }
}

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

export default PostListPage;

      Próximos passos

      • Capacidades completas oferecidas por useFlowContext — veja Context (contexto)
      • Personalização de estilos e temas — veja Styles & Themes (estilos e temas)
      • Se o seu componente precisa aparecer no menu "Adicionar bloco / campo / ação" do NocoBase e suportar configuração visual pelo usuário, envolva-o com FlowModel — veja FlowEngine
      • Não tem certeza se deve usar Component ou FlowModel? — veja Component vs FlowModel