interface

MountAdminOptions

Public interface MountAdminOptions from @riducms/admin.

Properties

Property	Type	Description
`target`	`Element`	Existing DOM element that receives the Ridu admin application.
`clientFactory`	`() => RiduClient<Config>`	Creates the generated, application-specific Fetch client.
`adminBasePath`	`string \| undefined`	Route prefix used when the admin is not mounted at /admin.
`rowLabels`	Readonly<Record<`app:${string}`, RegisteredRowLabel>> \| undefined	Custom array or block row headings selected by Go `field.Admin{RowLabel: field.Component("app:name")}`.
`plugins`	`readonly AdminPlugin[] \| undefined`	Statically paired packaged plugins, including fields and routes.
`messages`	`PluginMessageCatalog \| undefined`	Interface messages made with `defineAdminMessages`; refer to them as `app:messageName`.
`languages`	`readonly TranslationLanguage[] \| undefined`	Statically imported catalogs available to the Go-configured admin languages.
`routes`	`readonly AdminRoute[] \| undefined`	Authenticated admin routes contributed by this package.
`dashboardPanels`	`readonly AdminDashboardPanel[] \| undefined`	Panels composed into or replacing the authenticated dashboard.
`login`	`readonly AdminLoginComponent[] \| undefined`	Components composed around or replacing the sign-in screen.
`account`	`readonly AdminAccountComponent[] \| undefined`	Components composed around or replacing the framework account screens.
`navigation`	`readonly AdminNavigationComponent[] \| undefined`	Components composed around or replacing the framework navigation.
`logoutButton`	`AdminLogoutButton \| undefined`	Replaces the default sign-out control in the navigation footer.
`coreViews`	`readonly AdminCoreView[] \| undefined`	Wraps or replaces framework collection, global, and not-found views.
`branding`	`readonly AdminBrandComponent[] \| undefined`	Replaces framework-owned brand graphics at exact shell surfaces.
`shellSlots`	`readonly AdminShellSlot[] \| undefined`	Adds components to explicit global shell slots.
`providers`	`readonly AdminProvider[] \| undefined`	Wraps the admin in statically ordered Svelte context providers.
`listCellRenderers`	`readonly AdminListCellRenderer[] \| undefined`	Collection list cells rendered for exact collection/field pairs.
`listResultsRenderers`	`readonly AdminListResultsRenderer[] \| undefined`	Replace only the results layout; Ridu retains list loading, controls and pagination.
`documentActions`	`readonly AdminDocumentAction[] \| undefined`	Actions rendered alongside framework-owned document actions.
`documentViews`	`readonly AdminDocumentView[] \| undefined`	Read-only or operational views rendered beside Edit and API.
`fieldEditors`	Readonly<Record<`app:${string}`, RegisteredFieldEditor>> \| undefined	Custom field inputs selected by Go `field.Admin{Editor: field.Component("app:name")}`. Use `defineFieldEditor` for each entry.

Full signature

interface MountAdminOptions<Config extends RiduConfigShape> { ... }

Source admin/src/index.ts:14

Methods

MountAdminOptions.clientFactory()
Creates the generated, application-specific Fetch client.