goto

abstract fun goto(path: String, config: GotoConfig = GotoConfig.Default): NavResponse

Navigate to a page, field, or row with configuration options.

Return

NavResponse.Success if the target exists, is supported, and is visible. NavResponse.Failure if the target does not exist, is not supported, or is hidden.

Parameters

path

Navigation path: - "pageId" navigates to the page top. - "pageId/fieldPositionId" navigates to the page and scrolls to the field. - "pageId/fieldPositionId/rowId" navigates to a row within a table/collection. - "pageId/fieldPositionId/rowId/columnId" navigates to a row and optional column in RowForm mode.

config

Navigation configuration including GotoConfig.open to auto-open row forms and GotoConfig.animate for scroll animation.


abstract fun goto(route: Route, config: GotoConfig = GotoConfig.Default): NavResponse

Navigate to a specific page, field, or row within the document editor using a type-safe route.

Return

A NavResponse indicating the result of the navigation request: - NavResponse.Success if the target exists, is supported, and is visible. - NavResponse.Failure if the target does not exist, is not supported, or is hidden.

Parameters

route

The Route specifying the navigation target. Supported routes include: - Route.PageRoute to navigate to the top of a specific page. - Route.FieldRoute to navigate to a specific field within a page. - Route.RowRoute to navigate to a specific row within a table or collection.

config

A GotoConfig object specifying navigation options such as animation (GotoConfig.animate) or row form auto-opening (GotoConfig.open). Defaults to GotoConfig.Default.


abstract fun goto(path: String, animate: Boolean): NavResponse

Deprecated

Use goto(path, config) instead. Animation can be controlled via GotoConfig.

Replace with

goto(path, GotoConfig(animate = animate))