Pular para o conteúdo

Sistema de Plugins

Plugins são o principal mecanismo de extensão no Rebase. Eles podem:

  • Envolver todo o aplicativo com um provedor (contexto, gerenciamento de estado)
  • Adicionar ações e widgets à página inicial
  • Injetar componentes da visualização de coleção (barra de ferramentas, construtores de colunas)
  • Adicionar componentes de formulário (construtores de campos, painéis adicionais)
  • Injetar ou modificar coleções dinamicamente
interface RebasePlugin {
key: string; // Unique identifier
loading?: boolean; // Show loading state while initializing
// Wrap the app with a provider
provider?: {
Component: React.ComponentType;
};
// Home page customization
homePage?: {
additionalActions?: React.ReactNode;
additionalChildrenStart?: React.ReactNode;
additionalChildrenEnd?: React.ReactNode;
};
// Collection view customization
collectionView?: {
showTextSearchBar?: boolean;
CollectionActions?: React.ComponentType[];
AddColumnComponent?: React.ComponentType;
onCellValueChange?: (params) => void;
};
// Entity form customization
form?: {
Actions?: React.ComponentType;
provider?: { Component: React.ComponentType };
fieldBuilder?: (params) => React.ReactNode | null;
};
// Collection injection/modification
collection?: {
injectCollections?: (params) => EntityCollection[];
modifyCollection?: (params) => EntityCollection;
};
}

Passe as instâncias do plugin para o controlador de navegação:

const dataEnhancementPlugin = useDataEnhancementPlugin();
const plugins = [dataEnhancementPlugin];
const navigationStateController = useBuildNavigationStateController({
plugins,
collections: () => collections,
// ...
});

Aqui está um plugin mínimo que adiciona uma ação à barra de ferramentas para cada coleção:

import { RebasePlugin } from "@rebasepro/types";
function useMyPlugin(): RebasePlugin {
return {
key: "my_plugin",
collectionView: {
CollectionActions: [MyToolbarAction]
},
form: {
fieldBuilder: ({ property, ...rest }) => {
// Return a custom field for specific property configs
if (property.propertyConfig === "my_custom_field") {
return <MyCustomField {...rest} />;
}
return null; // Use default field
}
}
};
}

Autocompletar campo com IA:

import { useDataEnhancementPlugin } from "@rebasepro/data_enhancement";
const enhancementPlugin = useDataEnhancementPlugin();

Aprimoramento de dados

Plugins podem adicionar novas coleções dinamicamente:

collection: {
injectCollections: ({ collections, user }) => {
// Add an audit log collection for admins
if (user?.roles?.includes("admin")) {
return [auditLogCollection];
}
return [];
}
}

Plugins podem modificar coleções existentes:

collection: {
modifyCollection: ({ collection }) => {
// Add a "last_modified_by" field to every collection
return {
...collection,
properties: {
...collection.properties,
last_modified_by: {
type: "string",
name: "Modified By",
readOnly: true
}
}
};
}
}