@finos/legend-application
Version:
Legend application core
45 lines • 2.21 kB
TypeScript
/**
* Copyright (c) 2020-present, Goldman Sachs
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { type NavigationAddress, type NavigationLocation, type ApplicationNavigator, type NavigationLocationParameterValue, type NavigationZone } from './NavigationService.js';
export declare class DefaultNavigator implements ApplicationNavigator {
goToLocation(location: NavigationLocation, options?: {
ignoreBlocking?: boolean | undefined;
}): void;
reload(options?: {
ignoreBlocking?: boolean | undefined;
}): void;
goToAddress(address: NavigationAddress, options?: {
ignoreBlocking?: boolean | undefined;
}): void;
visitAddress(address: NavigationAddress): void;
generateAddress(location: NavigationLocation): string;
updateCurrentLocation(location: NavigationLocation): void;
updateCurrentZone(zone: NavigationZone): void;
resetZone(): void;
getCurrentBaseAddress(options?: {
withAppRoot?: boolean | undefined;
}): NavigationAddress;
getCurrentAddress(): NavigationAddress;
getCurrentLocation(): NavigationLocation;
getCurrentLocationParameters<T extends Record<string, NavigationLocationParameterValue>>(): T;
getCurrentLocationParameterValue(key: string): NavigationLocationParameterValue;
getCurrentZone(): NavigationZone;
blockNavigation(blockCheckers: (() => boolean)[], onBlock?: ((onProceed: () => void) => void) | undefined, onNativePlatformNavigationBlock?: (() => void) | undefined): void;
unblockNavigation(): void;
get isNavigationBlocked(): boolean;
INTERNAL__internalizeTransientParameter(key: string): void;
}
//# sourceMappingURL=DefaultNavigator.d.ts.map