isNavigable

Updated:
Supported Platforms:
UUX

Checks Tecton or platform level features to see if they can be navigated to.

The isNavigable capability allows modules to safely check if another Tecton or platform-level feature is configured to be navigated to via something like navigateTo.

Within a module, this is determined by whether or not the navigable key is set to true or false in the feature's configuration. If the moduleName argument is not provided, the capability will find the module that has the primary key set to true and return the result of that module's navigable key.

Details

Type

tecton.sources.isNavigable(featureName: string, moduleName?: string): Promise<boolean>

Example

tecton.sources.isNavigable("MyFeature", "Main").then((isNavigable) => {
  // Do something
})
/*
Promise<boolean>
Promise contains true/false answer to whether feature/module combination can be navigated to.
*/

Arguments

UUX

Unique name of a Tecton or platform feature

UUX

Defines a module name to check for the ability to be navigated to. If this argument is not provided for a Tecton feature, it will return the result of the module that has the primary key set to true.

Only supported in Tecton features.

Release Notes

Initial Release