User menu

The signed-in user sits at the bottom of the sidebar. Clicking them opens a menu with their name and email, the app’s own pages, and “Sign out”. Account pages (organization, billing, users) and help links belong here rather than among the working resources.

Export one userMenu(...) from the config module:

// examples/erp/config/user-menu.ts, re-exported from config/index.ts
import { userMenu } from 'protobase/schema'

export const accountMenu = userMenu((m) => [
  m.resource('organizations', { label: 'Organization', icon: 'building' }),
  m.resource('users', { label: 'Users', icon: 'users' }),
  m.link('Documentation', 'https://docs.protobase.net', { icon: 'book-open' }),
  m.link('Support', 'mailto:[email protected]', { icon: 'life-buoy' }),
])

Item	Does
m.resource(name, { label?, icon? })	Opens the resource’s list. The resource leaves the sidebar. The label defaults to the view’s plural name.
m.page(name, { label?, icon? })	Opens a composed page. The page leaves the sidebar. The label defaults to its title.
m.link(label, href, { icon? })	Opens href in a new tab. Only https://, http:// and mailto: are accepted.

Items keep their order; “Sign out” always comes last. icon is one of book-open, building, credit-card, external-link, file-text, key, layout-dashboard, life-buoy, mail, receipt, settings, shield, users. A resource item without one uses the resource’s sidebar icon, and a link item uses external-link.

Every caller gets the menu through /meta, without the resources and pages they cannot see, so a user who cannot read organizations has no “Organization” item. Links are shown to everyone. createAdmin refuses to start when an item names a resource or page that does not exist, and configExports refuses a config module that exports two menus.

protobase dev, protobase build and protobase serve pick the menu up from the config module. With createAdmin directly, pass it as userMenu:

const { resources, views, userMenu } = configExports(config)
const admin = createAdmin({ resources, views, userMenu, db, authenticate })