@y3krulez/angular-archwizard
Version:
The port of angular-archwizard, supporting IVY and thus being compatible with Angular16+
79 lines (78 loc) • 3.01 kB
TypeScript
import { OnChanges, SimpleChanges } from '@angular/core';
import { NavigationMode } from '../navigation/navigation-mode.interface';
import { WizardComponent } from '../components/wizard.component';
import * as i0 from "@angular/core";
/**
* The [[awNavigationMode]] directive can be used to customize wizard'd navigation mode.
*
* There are several usage options:
*
* ### Option 1. Customize the default navigation mode with [[navigateBackward]] and/or [[navigateForward]] inputs.
*
* ```html
* <aw-wizard [awNavigationMode] navigateBackward="deny" navigateForward="allow">...</aw-wizard>
* ```
*
* ### Option 2. Pass in a custom navigation mode
*
* ```typescript
* import { BaseNavigationMode } from 'angular-archwizard'
*
* class CustomNavigationMode extends BaseNavigationMode {
*
* // ...
* }
* ```
*
* ```typescript
* @Component({
* // ...
* })
* class MyComponent {
*
* navigationMode = new CustomNavigationMode();
* }
* ```
*
* ```html
* <aw-wizard [awNavigationMode]="navigationMode">...</aw-wizard>
* ```
*
* ### Additional Notes
*
* - Specifying a custom navigation mode takes priority over [[navigateBackward]] and [[navigateForward]] inputs
*
* - Omitting the [[awNavigationMode]] directive or, equally, specifying just [[awNavigationMode]] without
* any inputs or parameters causes the wizard to use the default "strict" navigation mode equivalent to
*
* ```html
* <aw-wizard [awNavigationMode] navigateBackward="deny" navigateForward="allow">...</aw-wizard>
* ````
*/
export declare class NavigationModeDirective implements OnChanges {
private wizard;
/**
* Custom navigation mode instance (optional).
*/
awNavigationMode: NavigationMode | null;
/**
* A parameter for the default navigation mode. Controls whether wizard steps before the current step are navigable:
*
* - `navigateBackward="deny"` -- the steps are not navigable
* - `navigateBackward="allow"` -- the steps are navigable
*/
navigateBackward: 'allow' | 'deny' | null;
/**
* A parameter for the default navigation mode. Controls whether wizard steps after the current step are navigable:
*
* - `navigateForward="deny"` -- the steps are not navigable
* - `navigateForward="allow"` -- the steps are navigable
* - `navigateForward="visited"` -- a step is navigable iff it was already visited before
*/
navigateForward: 'allow' | 'deny' | 'visited' | null;
constructor(wizard: WizardComponent);
ngOnChanges(changes: SimpleChanges): void;
private getNavigationMode;
static ɵfac: i0.ɵɵFactoryDeclaration<NavigationModeDirective, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<NavigationModeDirective, "[awNavigationMode]", never, { "awNavigationMode": "awNavigationMode"; "navigateBackward": "navigateBackward"; "navigateForward": "navigateForward"; }, {}, never, never, false, never>;
}