Ant Design Plugin
@vibeflui/antd registers an Ant Design field adapter and adapter metadata.
Install
BASH
npm install @vibeflui/core @vibeflui/antd antdantd is an optional peer dependency in package metadata, but the adapter needs it to render Ant Design controls.
Public exports
| Export | Purpose |
|---|---|
createAntdPlugin | Creates the Ant Design plugin. |
antdPlugin | Prebuilt plugin instance. |
AntdField | Field adapter component. |
Registered slots
| Slot | Keys |
|---|---|
adapters | antd |
fieldAdapters | antd |
messages | loadError, submitError |
Minimal setup
TSX
import { FluiKit, FluiKitProvider } from "@vibeflui/core";
import { createAntdPlugin } from "@vibeflui/antd";
const antdPlugin = createAntdPlugin();
export function UsersPage() {
return (
<FluiKitProvider plugins={[antdPlugin]}>
<FluiKit schema={usersSchema} />
</FluiKitProvider>
);
}Schema usage
TS
export const usersSchema = {
resource: "users",
adapter: "antd",
form: {
fields: [
{ name: "name", label: "Name", type: "text", adapter: "antd" },
{ name: "role", label: "Role", type: "select", adapter: "antd", options: [{ label: "Admin", value: "admin" }] },
{ name: "enabled", label: "Enabled", type: "switch", adapter: "antd" }
]
},
registry: {
fieldAdapters: ["antd"]
}
} as const;Supported field behavior
The adapter handles text-like fields, textarea/json/code/markdown text areas, password, number/range, select, multiselect/tags, switch, checkbox, radio/radio-group, checkbox-group, date, datetime, and email.
Plugin overrides
createAntdPlugin() accepts optional renderers, components, fieldAdapters, and messages. Use this when the app needs Ant Design form controls plus project-specific renderers or components.
TS
import { createAntdPlugin } from "@vibeflui/antd";
import { InvoiceStatusBadge } from "@/components/vibeflui/renderers/invoices/InvoiceStatusBadge";
export const antdPlugin = createAntdPlugin({
renderers: {
InvoiceStatusBadge
}
});Common mistakes
- Use the plugin exports shown above.
- Do not expect Ant Design table rendering from this package. It provides a field adapter and adapter metadata.