@natec/mef-dev-ui-kit 16.2.4 → 16.2.5

package/lib/markup-kit/card/card.module.d.ts

@@ -9,7 +9,7 @@ import * as i4 from "@angular/common";
 import * as i5 from "../collapse/collapse.module";
 import * as i6 from "../../pg-components/select/select.module";
 import * as i7 from "../../pg-components/card/card.module";
-export declare const mefDevCardComponents: (typeof CardLongComponent | typeof CardComponent | typeof CardSimpleComponent)[];
+export declare const mefDevCardComponents: (typeof CardComponent | typeof CardLongComponent | typeof CardSimpleComponent)[];
 export declare class MefDevCardModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<MefDevCardModule, never>;
     static ɵmod: i0.ɵɵNgModuleDeclaration<MefDevCardModule, [typeof i1.CardComponent, typeof i2.CardLongComponent, typeof i3.CardSimpleComponent], [typeof i4.CommonModule, typeof i5.MefDevCollapseModule, typeof i6.MefDevSelectModule, typeof i7.pgCardModule], [typeof i1.CardComponent, typeof i2.CardLongComponent, typeof i3.CardSimpleComponent]>;

package/lib/markup-kit/executors/mefdev-executor-page/mefdev-executor-page.component.d.ts

@@ -1,12 +1,80 @@
 import { ElementRef, EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
 import { StepExecutorComponent } from '../step-executor/step-executor.component';
 import * as i0 from "@angular/core";
+/**
+ * A component that allows us to create a content page - a step in our executor.
+ * Each individual step can have different styles, content and settings.
+ *
+ * Example of usage:
+ *
+ * ```
+ *  <mefdev-executor-page
+ *     [title]="'Executor title 1'"
+ *     [isActive]="mainExecutor.activePageInd === 0"
+ *     [isCompleted]="mainExecutor.activePageInd >= 0"
+ *     class="yourClass">
+ *      <!-- Content of the first executor step -->
+ *  </mefdev-executor-page>
+ *  <mefdev-executor-page
+ *     [title]="'Executor title 2'"
+ *     [isActive]="mainExecutor.activePageInd === 1"
+ *     [isCompleted]="mainExecutor.activePageInd >= 1"
+ *     class="yourClass">
+ *      <!-- Content of the second executor step -->
+ *  </mefdev-executor-page>
+ *  <mefdev-executor-page
+ *     [title]="'Executor title 3'"
+ *     [isActive]="mainExecutor.activePageInd === 2"
+ *     [isCompleted]="mainExecutor.activePageInd >= 2"
+ *     class="yourClass">
+ *      <!-- Content of the third executor step -->
+ *  </mefdev-executor-page>
+ * ```
+ *
+  */
 export declare class MefdevExecutorPageComponent implements OnChanges {
     private _mainExecutor;
     private _elementRef;
+    /**
+     * The title of the step
+     * @usageNotes
+     * ```
+     *  <mefdev-executor-page [title]="'Description of situation 1'"></mefdev-executor-page>
+     * ```
+     */
     title: string;
+    /**
+     * The input parameter that corresponds to whether the current step matches the respective page.
+     * The value of the active page is passed by reference from the specific component StepExecutorComponent.
+     *
+     * @usageNotes
+     * ```
+     *  <mefdev-step-executor #mainExecutor>
+     *    <mefdev-executor-page [isActive]="mainExecutor.activePageInd === 0">
+     *    <mefdev-executor-page [isActive]="mainExecutor.activePageInd === 1">
+     *    <mefdev-executor-page [isActive]="mainExecutor.activePageInd === 2">
+     *  </<mefdev-step-executor>
+     *
+     * ```
+     */
     isActive: boolean;
+    /**
+     * The input parameter that checks whether the step is completed.
+     *
+     * @usageNotes
+     * ```
+     *  <mefdev-executor-page [isCompleted]="mainExecutor.activePageInd >= 0"></mefdev-executor-page>
+     * ```
+     */
     isCompleted: boolean;
+    /**
+     * The output parameter that emits a boolean value indicating whether our completed step has changed.
+     *
+     * @usageNotes
+     * ```
+     *  <mefdev-executor-page (isCompletedChange)="onStepChanged($event)"></mefdev-executor-page>
+     * ```
+     */
     isCompletedChange: EventEmitter<boolean>;
     elRef: ElementRef;
     constructor(_mainExecutor: StepExecutorComponent, _elementRef: ElementRef);

package/lib/markup-kit/executors/stage/stage.component.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * @ignore
+ */
 export declare class StageComponent {
     currentExecutorStep: number;
     isRightModal: boolean;

package/lib/markup-kit/executors/step-executor/step-executor.component.d.ts

@@ -1,13 +1,104 @@
 import { AfterViewInit, ElementRef, EventEmitter, Renderer2, TemplateRef } from '@angular/core';
 import { MefdevExecutorPageComponent } from '../mefdev-executor-page/mefdev-executor-page.component';
 import * as i0 from "@angular/core";
+/**
+ * Wrapper component that represents a specific encapsulated executor.
+ *
+ * Example of usage:
+ *```
+ * <mefdev-step-executor #mainExecutor [view]="'regular'">
+ *
+ *  <ng-template #title>
+ *    <!-- Content for the executor title -->
+ *  </ng-template>
+ *  <ng-template #description>
+ *    <!-- Content for the executor description -->
+ *  </ng-template>
+ *
+ *  <mefdev-executor-page
+ *     [title]="'Description of situation 1'"
+ *     [isActive]="mainExecutor.activePageInd === 0"
+ *     [isCompleted]="mainExecutor.activePageInd >= 0">
+ *      <!-- Content of the first executor step -->
+ *  </mefdev-executor-page>
+ *  <mefdev-executor-page
+ *    [title]="'Description of situation 2'"
+ *    [isActive]="mainExecutor.activePageInd === 1"
+ *    [isCompleted]="mainExecutor.activePageInd >= 1">
+ *     <!-- Content of the second executor step -->
+ *  </mefdev-executor-page>
+ *  <mefdev-executor-page
+ *    [title]="'Description of situation 3'"
+ *    [isActive]="mainExecutor.activePageInd === 2"
+ *    [isCompleted]="mainExecutor.activePageInd >= 2">
+ *      <!-- Content of the third executor step -->
+ *  </mefdev-executor-page>
+ *
+ *  <ng-template #footer>
+ *    <!-- Content for the executor footer -->
+ *  <ng-template>
+ *
+ * </mefdev-step-executor>
+ *
+ *```
+ */
 export declare class StepExecutorComponent implements AfterViewInit {
     private renderer;
+    /**
+     * Mandatory input parameter that specifies the type of the step-by-step wizard.
+     * It can have three options: regular, modal, right.
+     *
+     * @usageNotes
+     * ```
+     *  <mefdev-step-executor #mainExecutor [view]="'regular'"></mefdev-step-executor>
+     * ```
+     */
     view: string;
+    /**
+     * ViewChild reference to the host executor content.
+     */
     container: ElementRef<HTMLElement>;
+    /**
+     * Template for displaying the content of the executor title.
+     *
+     * @usageNotes
+     * ```
+     * <ng-template #title>
+     *   <!-- Content for the executor title -->
+     * </ng-template>
+     * ```
+     */
     title: TemplateRef<void>;
+    /**
+     * Template for displaying the content of the executor description.
+     *
+     * @usageNotes
+     * ```
+     * <ng-template #description>
+     *  <!-- Content for the executor description -->
+     * </ng-template>
+     * ```
+     */
     description: TemplateRef<void>;
+    /**
+     * Template for displaying the content of the executor footer.
+     *
+     * @usageNotes
+     * ```
+     * <ng-template #footer>
+     *    <!-- Content for the executor footer -->
+     * </ng-template>
+     * ```
+     */
     footer: TemplateRef<void>;
+    /**
+     * The output parameter that emits the class of the active page - active step.
+     *
+     * @usageNotes
+     * ```
+     *  <mefdev-step-executor #mainExecutor (onActivePageChange)="getActiveStep($event)"></mefdev-step-executor>
+     * ```
+     */
     onActivePageChange: EventEmitter<MefdevExecutorPageComponent>;
     _activePageInd: number;
     pages: MefdevExecutorPageComponent[];
@@ -16,13 +107,37 @@ export declare class StepExecutorComponent implements AfterViewInit {
     get activePageInd(): number;
     get activePage(): MefdevExecutorPageComponent | null;
     ngAfterViewInit(): void;
+    /**
+     * Check whether there is a next step of the executor. If we are at the last step - disable the 'next' button
+     */
     nextBtnIsDisabled(): boolean;
+    /**
+     * Check whether there is a next step of the executor. If we are at the last step - disable the 'next' button
+     */
     prev(): void;
+    /**
+     * Go back to the previous step
+     */
     cancel(): void;
+    /**
+     * Go to the next step
+     */
     next(): void;
+    /**
+     * Set a specific active page
+     */
     setActivePage(pageNumber: number): void;
+    /**
+     * Add new page
+     */
     addPage(page: MefdevExecutorPageComponent): void;
+    /**
+     * Delete a specific page
+     */
     removeSpecificPage(page: MefdevExecutorPageComponent): void;
+    /**
+     * Delete a page by its index
+     */
     removePageByIndex(index: number): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<StepExecutorComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<StepExecutorComponent, "mefdev-step-executor", never, { "view": { "alias": "view"; "required": true; }; }, { "onActivePageChange": "onActivePageChange"; }, ["title", "description", "footer"], never, false, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@natec/mef-dev-ui-kit",
-  "version": "16.2.4",
+  "version": "16.2.5",
   "description": "MEF.DEV UI Kit Library",
   "author": {
     "name": "NATEC"