Skip to main content

Navigation

The sdk.navigation object allows developers to programmatically navigate between major areas of the GridStudio interface. This is especially useful when you want to guide the user to specific tabs, views, or contextual screens after an action is completed.

Navigation is handled using internal routing, with support for query parameters and reactive state injection.

API​

sdk.navigation.goTo.settings({ slug })​

Navigates the user to the settings screen of the specified tenant slug.

Chained Routes:​

  • billing() → Navigates to the Billing tab.

    • balances() → Opens the Balances section.
    • transactions() → Opens the Transactions section.
    • currentSubscriptionPlan() → Opens the Subscription Plan tab.
    • currentExtraPackages() → Opens the Extra Packages section.
    • currentSupportPlan() → Opens the Support Plan tab.
    • currentPartnerPlan() → Opens the Partner Plan tab.
sdk.navigation.goTo.settings({ slug: 'acme-corp' })
  .billing()
  .transactions()

sdk.navigation.goTo.chat({ assignedUserIds, channels, customerUserIds, keyword })​

Navigates to the chat/messages tab with optional filters.

sdk.navigation.goTo.chat({
  assignedUserIds: ['user123'],
  keyword: 'pricing'
})

Notes​

  • You can combine multiple navigation layers using method chaining.
  • Filters in chat are stored in temporary reactive variables.
  • This utility is intended for internal view transitions—not for external redirects.