mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-15 20:17:22 +00:00
docs: added basic Admin UI configuration documentation
Added a new `BkndAdminConfig` type to streamline Admin UI configuration options, consolidating properties for base path, logo return path, theme, entities, and app shell settings. Updated `BkndAdminProps` to utilize this new configuration type. Additionally, introduced a new documentation section for extending the Admin UI, detailing customization options and providing examples for advanced usage.
This commit is contained in:
@@ -8,7 +8,33 @@ import * as AppShell from "ui/layouts/AppShell/AppShell";
|
||||
import { ClientProvider, useBkndWindowContext, type ClientProviderProps } from "./client";
|
||||
import { createMantineTheme } from "./lib/mantine/theme";
|
||||
import { Routes } from "./routes";
|
||||
import type { BkndAdminAppShellOptions, BkndAdminEntitiesOptions } from "ui/options";
|
||||
import type { BkndAdminAppShellOptions, BkndAdminEntitiesOptions } from "./options";
|
||||
|
||||
export type BkndAdminConfig = {
|
||||
/**
|
||||
* Base path of the Admin UI
|
||||
* @default `/`
|
||||
*/
|
||||
basepath?: string;
|
||||
/**
|
||||
* Path to return to when clicking the logo
|
||||
* @default `/`
|
||||
*/
|
||||
logo_return_path?: string;
|
||||
/**
|
||||
* Theme of the Admin UI
|
||||
* @default `system`
|
||||
*/
|
||||
theme?: AppTheme;
|
||||
/**
|
||||
* Entities configuration like headers, footers, actions, field renders, etc.
|
||||
*/
|
||||
entities?: BkndAdminEntitiesOptions;
|
||||
/**
|
||||
* App shell configuration like user menu actions.
|
||||
*/
|
||||
appShell?: BkndAdminAppShellOptions;
|
||||
};
|
||||
|
||||
export type BkndAdminProps = {
|
||||
/**
|
||||
@@ -16,37 +42,13 @@ export type BkndAdminProps = {
|
||||
*/
|
||||
baseUrl?: string;
|
||||
/**
|
||||
* Whether to wrap Admin in a <ClientProvider />
|
||||
* Whether to wrap Admin in a `<ClientProvider />`
|
||||
*/
|
||||
withProvider?: boolean | ClientProviderProps;
|
||||
/**
|
||||
* Admin UI customization options
|
||||
*/
|
||||
config?: {
|
||||
/**
|
||||
* Base path of the Admin UI
|
||||
* @default `/`
|
||||
*/
|
||||
basepath?: string;
|
||||
/**
|
||||
* Path to return to when clicking the logo
|
||||
* @default `/`
|
||||
*/
|
||||
logo_return_path?: string;
|
||||
/**
|
||||
* Theme of the Admin UI
|
||||
* @default `system`
|
||||
*/
|
||||
theme?: AppTheme;
|
||||
/**
|
||||
* Entities configuration like headers, footers, actions, field renders, etc.
|
||||
*/
|
||||
entities?: BkndAdminEntitiesOptions;
|
||||
/**
|
||||
* App shell configuration like user menu actions.
|
||||
*/
|
||||
appShell?: BkndAdminAppShellOptions;
|
||||
};
|
||||
config?: BkndAdminConfig;
|
||||
children?: ReactNode;
|
||||
};
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
export { default as Admin, type BkndAdminProps } from "./Admin";
|
||||
export { default as Admin, type BkndAdminProps, type BkndAdminConfig } from "./Admin";
|
||||
export * from "./components/form/json-schema-form";
|
||||
export { JsonViewer } from "./components/code/JsonViewer";
|
||||
export type * from "./options";
|
||||
|
||||
Reference in New Issue
Block a user