Skip to content

useMongocampPaths ​

Returns the base routes of your app's MongoCamp pages — the module option paths with the defaults filled in.

ts
const paths = useMongocampPaths()
// {
//   home: '/secured',
//   collections: '/secured/admin/collections',
//   buckets: '/secured/admin/buckets',
//   users: '/secured/admin/users',
//   roles: '/secured/admin/roles',
//   jobs: '/secured/admin/jobs',
//   settings: '/secured/admin/settings',
//   account: '/secured/account',
//   permissions: '/secured/admin/permissions',
//   overview: '/secured/admin/overview',
//   databases: '/secured/admin/databases',
//   server: '/secured/admin/server',
// }

It is a plain object, not a ref: the option is fixed when the app is built.

The components use it for every link whose *Path prop you did not set. For a ready-made, role-aware menu of these pages see useMongocampNavigation; for single links of your own, read the values directly:

vue
<script setup lang="ts">
const paths = useMongocampPaths()
const { canSeeAdmin } = useMongocampRoles()

const items = computed(() => [
  { label: 'Collections', to: paths.collections },
  ...(canSeeAdmin.value ? [{ label: 'Users', to: paths.users }, { label: 'Roles', to: paths.roles }] : []),
  { label: 'Account', to: paths.account },
])
</script>

Links to a single item are built from the base route:

PageLink
A collection's overview${paths.collections}/${name}
A collection's documents${paths.collections}/${name}/data
A bucket's files${paths.buckets}/${bucket}
A role's grants${paths.roles}/${role}

A configured value never ends with a slash — a trailing one is removed.

Released under the MIT License.