@testgorilla/tgo-ui 2.31.1 → 2.31.2

package/README.md

@@ -1,95 +1,95 @@
-# TestGorilla UI Library
-
-# Test app
-
-To see the updates of the library in the client app, use commands below from package.json
-
-- build the updated version of canopy-ui with `build:tgo-ui (ng build tgo-ui)`
-- restart the client app with `start:client (ng serve)`
-
-# Foundations
-
-- Typography
-- Colors
-
-# Components
-
-- Alert Bars
-  - Alert Banner
-  - Banner Actions
-  - Snackbar
-- Button
-- Elevation Shadow
-- Dialog
-  - Confirm Dialog
-  - Custom Dialog
-- File Upload
-- Forms
-  - Checkbox
-  - Datepicker
-  - Dropdown
-  - Input Field
-  - Radio
-- Icon
-  - Icon + Label
-- Logo
-- Overflow Menu
-- Progress Bar
-- Tag
-- Tooltip
-
-# Deprecated
-
-- Card
-- Create Account
-- Create Password
-- Forgot Password
-- Label
-- Login
-- NavBar
-- Navigation
-- Paginator
-- Table
-
-## Visual Regression
-
-We use Playwright to capture visual differences. The relevant code is in the `visual-tests` folder.
-
-### Updating Snapshots
-
-To ensure consistency with CI, update snapshots using Docker:
-
-```
-docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/playwright:latest /bin/bash
-npx playwright install
-npx playwright test visual-tests --config 'visual-tests/playwright.config.ts' --update-snapshots
-```
-
-If you encounter the following error, it can be safely ignored. We need reports in a single directory for CI artifact storage:
-
-```
-Configuration Error: HTML reporter output folder clashes with the tests output folder:
-
-    html reporter folder: /work/test-results/html-report
-    test results folder: /work/test-results
-
-HTML reporter will clear its output directory prior to being generated, which will lead to the artifact loss.
-```
-
-### Running Visual Tests
-
-Use Docker to align screenshots with the same OS:
-
-```
-docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/playwright:latest /bin/bash
-npx playwright install
-npx playwright test visual-tests --config 'visual-tests/playwright.config.ts'
-```
-
-### Running Visual Tests for a single file 
-
-```
-npx playwright test visual-tests --config ‘visual-tests/playwright.config.ts’ -g ‘test_name’
-npx playwright test visual-tests/path_to_test_file --config ‘visual-tests/playwright.config.ts’
-```
-
+# TestGorilla UI Library
+
+# Test app
+
+To see the updates of the library in the client app, use commands below from package.json
+
+- build the updated version of canopy-ui with `build:tgo-ui (ng build tgo-ui)`
+- restart the client app with `start:client (ng serve)`
+
+# Foundations
+
+- Typography
+- Colors
+
+# Components
+
+- Alert Bars
+  - Alert Banner
+  - Banner Actions
+  - Snackbar
+- Button
+- Elevation Shadow
+- Dialog
+  - Confirm Dialog
+  - Custom Dialog
+- File Upload
+- Forms
+  - Checkbox
+  - Datepicker
+  - Dropdown
+  - Input Field
+  - Radio
+- Icon
+  - Icon + Label
+- Logo
+- Overflow Menu
+- Progress Bar
+- Tag
+- Tooltip
+
+# Deprecated
+
+- Card
+- Create Account
+- Create Password
+- Forgot Password
+- Label
+- Login
+- NavBar
+- Navigation
+- Paginator
+- Table
+
+## Visual Regression
+
+We use Playwright to capture visual differences. The relevant code is in the `visual-tests` folder.
+
+### Updating Snapshots
+
+To ensure consistency with CI, update snapshots using Docker:
+
+```
+docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/playwright:latest /bin/bash
+npx playwright install
+npx playwright test visual-tests --config 'visual-tests/playwright.config.ts' --update-snapshots
+```
+
+If you encounter the following error, it can be safely ignored. We need reports in a single directory for CI artifact storage:
+
+```
+Configuration Error: HTML reporter output folder clashes with the tests output folder:
+
+    html reporter folder: /work/test-results/html-report
+    test results folder: /work/test-results
+
+HTML reporter will clear its output directory prior to being generated, which will lead to the artifact loss.
+```
+
+### Running Visual Tests
+
+Use Docker to align screenshots with the same OS:
+
+```
+docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/playwright:latest /bin/bash
+npx playwright install
+npx playwright test visual-tests --config 'visual-tests/playwright.config.ts'
+```
+
+### Running Visual Tests for a single file 
+
+```
+npx playwright test visual-tests --config ‘visual-tests/playwright.config.ts’ -g ‘test_name’
+npx playwright test visual-tests/path_to_test_file --config ‘visual-tests/playwright.config.ts’
+```
+

package/components/accordion/accordion.component.d.ts

@@ -0,0 +1,100 @@
+import { EventEmitter } from '@angular/core';
+import { ApplicationTheme } from '../../models/application-theme.model';
+import { AccordionVariant, ToggleIconPosition } from './accordion.model';
+import { IconName } from '../icon/icon.model';
+import * as i0 from "@angular/core";
+export declare class AccordionComponent {
+    private readonly defaultAppTheme;
+    /**
+     * The label displayed for the accordion.
+     * @type {string}
+     * @required
+     * @memberof AccordionComponent
+     */
+    label: string;
+    /**
+     * Determines whether the accordion is initially open.
+     * @type {boolean}
+     * @default false
+     * @memberof AccordionComponent
+     */
+    open: boolean;
+    /**
+     * Disables the accordion if set to true.
+     * @type {boolean}
+     * @default false
+     * @memberof AccordionComponent
+     */
+    disabled: boolean;
+    /**
+     * Indicates whether to show a premium icon.
+     * @type {boolean}
+     * @default false
+     * @memberof AccordionComponent
+     */
+    showPremiumIcon: boolean;
+    /**
+     * The tooltip text for the premium icon.
+     * @type {string}
+     * @default ''
+     * @memberof AccordionComponent
+     */
+    premiumTooltipText: string;
+    /**
+     *
+     * Defines the application theme where accordion is used
+     *
+     * @type {ApplicationTheme}
+     * @memberof AccordionComponent
+     */
+    applicationTheme: ApplicationTheme;
+    /**
+     *
+     * Changed premium icon on this icon
+     *
+     * @type {IconName}
+     * @memberof AccordionComponent
+     */
+    labelIcon: IconName;
+    /**
+     *
+     * Select accordion variant. Don`t work on Classic theme
+     *
+     * @type {AccordionVariant}
+     * @memberof AccordionComponent
+     */
+    variant: AccordionVariant;
+    /**
+     *
+     * Projects content with attribute 'customHeader'
+     *
+     * @type {boolean}
+     * @memberof AccordionComponent
+     */
+    allowCustomHeader: boolean;
+    /**
+     *
+     * Sets background color of content to none
+     *
+     * @type {boolean}
+     * @memberof AccordionComponent
+     */
+    noBackgroundColor: boolean;
+    /**
+     *
+     * Defines the toggle icon position
+     *
+     * @type {boolean}
+     * @memberof AccordionComponent
+     */
+    toggleIconPosition: ToggleIconPosition;
+    closed: EventEmitter<void>;
+    opened: EventEmitter<void>;
+    constructor(defaultAppTheme: ApplicationTheme);
+    protected toggle(open: boolean): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AccordionComponent, [{ optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AccordionComponent, "ui-accordion", never, { "label": { "alias": "label"; "required": true; }; "open": { "alias": "open"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "showPremiumIcon": { "alias": "showPremiumIcon"; "required": false; }; "premiumTooltipText": { "alias": "premiumTooltipText"; "required": false; }; "applicationTheme": { "alias": "applicationTheme"; "required": false; }; "labelIcon": { "alias": "labelIcon"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "allowCustomHeader": { "alias": "allowCustomHeader"; "required": false; }; "noBackgroundColor": { "alias": "noBackgroundColor"; "required": false; }; "toggleIconPosition": { "alias": "toggleIconPosition"; "required": false; }; }, { "closed": "closed"; "opened": "opened"; }, never, ["[subHeader]", "[customHeader]", "[actions]", "*"], false, never>;
+    static ngAcceptInputType_open: unknown;
+    static ngAcceptInputType_disabled: unknown;
+    static ngAcceptInputType_showPremiumIcon: unknown;
+}

package/components/accordion/accordion.component.module.d.ts

@@ -0,0 +1,12 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./accordion.component";
+import * as i2 from "@angular/common";
+import * as i3 from "../icon/icon.component.module";
+import * as i4 from "../button/button.component.module";
+import * as i5 from "@angular/material/tooltip";
+import * as i6 from "@angular/material/expansion";
+export declare class AccordionComponentModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AccordionComponentModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AccordionComponentModule, [typeof i1.AccordionComponent], [typeof i2.CommonModule, typeof i3.IconComponentModule, typeof i4.ButtonComponentModule, typeof i5.MatTooltipModule, typeof i6.MatExpansionModule], [typeof i1.AccordionComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AccordionComponentModule>;
+}

package/components/alert-banner/alert-banner.component.d.ts

@@ -0,0 +1,123 @@
+import { OnInit } from '@angular/core';
+import { DomSanitizer, SafeHtml } from '@angular/platform-browser';
+import { IconName } from '../../components/icon/icon.model';
+import { ApplicationTheme } from '../../models/application-theme.model';
+import { AlertBarType, AlertVariant } from '../../utils/alert-bar.model';
+import { LinkTargetType } from './alert-banner.model';
+import * as i0 from "@angular/core";
+export declare class AlertBannerComponent implements OnInit {
+    private readonly defaultAppTheme;
+    private domSanitizer;
+    constructor(defaultAppTheme: ApplicationTheme, domSanitizer: DomSanitizer);
+    /**
+     * Alert Banner type
+     *
+     * @type {AlertBarType}
+     * @default 'success'
+     * @memberof AlertBannerComponent
+     */
+    alertType: AlertBarType;
+    /**
+     * Alert Banner variant
+     *
+     * @type {AlertVariant}
+     * @default 'banner'
+     * @memberof AlertBannerComponent
+     */
+    alertVariant: AlertVariant;
+    /**
+     * Alert banner message
+     *
+     * @memberof AlertBannerComponent
+     */
+    set message(msg: string);
+    /**
+     * Include dismmiss button
+     *
+     * @default true
+     * @memberof AlertBannerComponent
+     */
+    includeDismissButton: boolean;
+    /**
+     * Include shadow or not
+     *
+     * @default false
+     * @memberof AlertBannerComponent
+     */
+    shadow: boolean;
+    /**
+     * Link text that will appended at the end of message
+     *
+     * @default ''
+     * @memberof AlertBannerComponent
+     */
+    linkText?: string | undefined;
+    /**
+     * Link url
+     *
+     * @memberof AlertBannerComponent
+     */
+    linkUrl?: string;
+    /**
+     * Link target
+     *
+     * @type {@type {LinkTargetType}}
+     * @default '_blank'
+     * @memberof AlertBannerComponent
+     */
+    linkTarget?: LinkTargetType;
+    /**
+     *
+     * Defines the application theme
+     *
+     * @type {ApplicationTheme}
+     * @default 'light'
+     * @memberof AlertBannerComponent
+     */
+    applicationTheme: ApplicationTheme;
+    /**
+     * Sets the full width
+     *
+     * @type {boolean}
+     * @memberof AlertBannerComponent
+     */
+    isFullWidth: boolean | undefined;
+    /**
+     * Close button tooltip
+     *
+     * @type {string}
+     * @default ''
+     * @memberof AlertBannerComponent
+     */
+    closeButtonTooltip: string;
+    /**
+     * Shows icon
+     *
+     * @type {boolean}
+     * @default true
+     * @memberof AlertBannerComponent
+     */
+    hasIcon: boolean;
+    /**
+     * A string representing the ARIA requirement for accessibility.
+     * This attribute is used to indicate whether an input field is required for form submission.
+     * @type {string}
+     * @memberof AlertBannerComponent
+     */
+    ariaDescribedby: string;
+    set secondaryAlerts(alerts: string[]);
+    get isDismissed(): boolean;
+    iconName: IconName;
+    visible: boolean;
+    fullWidth: boolean;
+    fixed: boolean;
+    position: string;
+    cssClass: string;
+    _message: SafeHtml;
+    _secondaryAlerts: SafeHtml[];
+    dismissAlertBanner: boolean;
+    ngOnInit(): void;
+    dismissClick(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AlertBannerComponent, [{ optional: true; }, null]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AlertBannerComponent, "ui-alert-banner", never, { "alertType": { "alias": "alertType"; "required": false; }; "alertVariant": { "alias": "alertVariant"; "required": false; }; "message": { "alias": "message"; "required": false; }; "includeDismissButton": { "alias": "includeDismissButton"; "required": false; }; "shadow": { "alias": "shadow"; "required": false; }; "linkText": { "alias": "linkText"; "required": false; }; "linkUrl": { "alias": "linkUrl"; "required": false; }; "linkTarget": { "alias": "linkTarget"; "required": false; }; "applicationTheme": { "alias": "applicationTheme"; "required": false; }; "isFullWidth": { "alias": "isFullWidth"; "required": false; }; "closeButtonTooltip": { "alias": "closeButtonTooltip"; "required": false; }; "hasIcon": { "alias": "hasIcon"; "required": false; }; "ariaDescribedby": { "alias": "ariaDescribedby"; "required": false; }; "secondaryAlerts": { "alias": "secondaryAlerts"; "required": false; }; }, {}, never, never, false, never>;
+}

package/components/alert-banner/alert-banner.component.module.d.ts

@@ -0,0 +1,11 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./alert-banner.component";
+import * as i2 from "@angular/common";
+import * as i3 from "../button/button.component.module";
+import * as i4 from "../icon/icon.component.module";
+import * as i5 from "../../pipes/ui-translate.pipe";
+export declare class AlertBannerComponentModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AlertBannerComponentModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AlertBannerComponentModule, [typeof i1.AlertBannerComponent], [typeof i2.CommonModule, typeof i3.ButtonComponentModule, typeof i4.IconComponentModule, typeof i5.UiTranslatePipe], [typeof i1.AlertBannerComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AlertBannerComponentModule>;
+}