useApiDocsGotoCommands() — supabase Function Reference

Source Code

apps/studio/components/interfaces/ProjectAPIDocs/ProjectAPIDocs.Commands.tsx lines 6–40

export function useApiDocsGotoCommands(options?: CommandOptions) {
  let { ref } = useParams()
  ref ||= '_'

  useRegisterCommands(
    COMMAND_MENU_SECTIONS.NAVIGATE,
    [
      {
        id: 'nav-api',
        name: 'Project API Docs',
        route: `/project/${ref}/api`,
        defaultHidden: true,
      },
      {
        id: 'nav-api-auth',
        name: 'Auth Docs',
        route: `/project/${ref}/api?page=auth`,
        defaultHidden: true,
      },
      {
        id: 'nav-api-user-management',
        name: 'User Management Docs',
        route: `/project/${ref}/api?page=users-management`,
        defaultHidden: true,
      },
      {
        id: 'nav-api-graphql',
        name: 'GraphQL Docs',
        route: `/project/${ref}/api/graphiql`,
        defaultHidden: true,
      },
    ],
    { ...options, deps: [ref] }
  )
}