Menu on Palmyra

AsyncTreeMenu

Mon, 01 Jan 0001 00:00:00 +0000

AsyncTreeMenu#

@palmyralabs/rt-forms · src/palmyra/menu/AsyncTreeMenu.tsx

Overview#

Sidebar tree menu. On mount it calls store.getRoot() once against a Wire TreeQueryStore to fetch the whole tree, converts the flat list into react-accessible-treeview nodes, and renders a checkbox-less expandable sidebar.

Selecting a leaf calls useNavigate() from react-router-dom with the leaf’s metadata.code (or metadata.target for non-leaf shortcut links). Expand state and the last selection are persisted to localStorage under the keys palmyra.rui.sidemenu.expanded and palmyra.rui.sidemenu.expanded.selected, so the menu restores itself on page refresh.

AsyncTreeMenuEditor

Mon, 01 Jan 0001 00:00:00 +0000

AsyncTreeMenuEditor#

@palmyralabs/rt-forms · src/palmyra/menu/AsyncTreeMenuEditor.tsx

Overview#

Admin-side counterpart to AsyncTreeMenu. Renders the same tree with checkbox selection so an administrator can edit which menu entries a given role/group can access.

Internally it builds its own TreeQueryStore from a factory (storeFactory.getTreeStore), seeded with endPointOptions: { groupId }, so the backend returns each node pre-marked with the group’s current mask value. On mount, nodes with mask == 2 are selected by default; descendants inherit via propagateSelect.

IconProvider

Mon, 01 Jan 0001 00:00:00 +0000

IconProvider#

@palmyralabs/rt-forms · src/palmyra/menu/IconProvider.ts

Overview#

Pluggable icon resolver consumed by AsyncTreeMenu. Given a menu node’s metadata.code (the same string that also acts as the router path), getIcon returns a React icon component — or undefined when nothing is mapped.

The file ships two symbols:

IconProvider — the interface (type-only export).
SimpleIconProvider — a default singleton backed by an empty map. Returns undefined for every lookup unless you patch the map, so nodes render without icons.

In practice you implement your own IconProvider and pass it to AsyncTreeMenu rather than extending the default.