@norwegian/core-components 6.0.3 → 6.2.0

package/lib/components/filter/filter.component.d.ts

@@ -3,7 +3,7 @@
  * Copyright Norwegian Air Shuttle. All Rights Reserved.
  */
 import { AfterViewChecked, ElementRef, EventEmitter, OnInit, ChangeDetectorRef } from '@angular/core';
-import { UntypedFormGroup } from '@angular/forms';
+import { FormGroup } from '@angular/forms';
 import { BehaviorSubject } from 'rxjs';
 import { TripType } from './enums/trip-type.enum';
 import { NasComponentBase } from '../../core/base/nas-component.base';
@@ -59,120 +59,143 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
     set inboundOpen(value: boolean);
     private inboundOpenTimeout;
     /**
+     * @property Input
      * @required
      * @description
      * A record containing keys with all airport codes with corresponding array of airport codes connected to the key.
      */
     airportRelations: Record<string, Array<string>>;
     /**
+     * @property Input
      * @description
      * Adds 'aria-label' on the clear button inside the airport select inputs.
      */
     ariaLabelClear: string;
     /**
+     * @property Input
      * @description
      * ARIA label for the subtract buttons.
      */
     ariaLabelSubtract: string;
     /**
+     * @property Input
      * @description
      * Adds 'aria-label' to the backdrops.
      */
     ariaLabelBackdrop: string;
     /**
+     * @property Input
      * @description
      * ARIA label for the add buttons.
      */
     ariaLabelAdd: string;
     /**
+     * @property Input
      * @description
      * A list of airports that should be displayed in the origin dropdown.
      * If not included, all airports will be displayed.
      */
     allowedOriginAirports: Array<AirportModel>;
     /**
+     * @property Input
      * @description
      * An array of airports that are restricted for destination airports. It will default to airports if not set.
      */
     allowedDestinationAirports: Array<AirportModel>;
     /**
+     * @property Input
      * @description
      * A boolean indicating if airports that the user allready has searh for should be displayed.
      */
     displayLatestSearches: boolean;
     /**
+     * @property Input
      * @description
      * Display switch UI to interchange origin and destination airport.
      */
     useSwitch?: boolean;
     /**
+     * @property Input
      * @description
      * A boolean indicating if airports that are close to the user should be displayed.
      */
     displayClosestAirports: boolean;
     /**
+     * @property Input
      * @description
      * The airport code of the origin airport. It will set the selected origin airport based on this value.
      */
     originAirportCode: string;
     /**
+     * @property Input
      * @description
      * The airport code of the destination airport. It will set the selected destination airport based on this value.
      */
     destinationAirportCode: string;
     /**
+     * @property Input
      * @description
      * A label that will be added to the passenger select dropdown.
      */
     passengerSelectLabel: string;
     /**
+     * @property Input
      * @description
      * The total maximum amount of passengers in the passenger select dropdown.
      */
     maxPaxCount: number;
     /**
+     * @property Input
      * @description
      * An array of different passenger types that will be displayed.
      */
     get passengers(): Array<PassengersModel>;
     set passengers(value: Array<PassengersModel>);
     /**
+     * @property Input
      * @description
      * The minimum amount of adults that can be selected in the passenger select dropdown.
      */
     minAdultCount: number;
     /**
+     * @property Input
      * @description
      * A label for round trip selection in the trip switch dropdown.
      */
     tripSwitchRoundTripLabel: string;
     /**
+     * @property Input
      * @description
      * A label for one way selection in the trip switch dropdown.
      */
     tripSwitchOneWayLabel: string;
     /**
+     * @property Input
      * @description
      * A label for direct only selection in the transit switch dropdown.
      */
     directOnlyLabel: string;
     /**
+     * @property Input
      * @description
      * A label for both direct and transit selection in the transit switch dropdown.
      */
     directTransitLabel: string;
     /**
+     * @property Input
      * @description
      * Indicates if the filter should be minimized on mobile screen sizes.
      */
     minimizeOnMobile?: boolean;
     /**
+    * @property Input
     * @description
     * Indicates if the edit search of accordion should be expended on mobile screen sizes.
     */
     get expandedAccordionMobile(): boolean;
     set expandedAccordionMobile(value: boolean);
     /**
+     * @property Input
      * @description
      * A separator for the filter summary that is dispayed if minimizeOnMobile is true.
      *
@@ -188,102 +211,121 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     lastSummarySeparator: string;
     /**
+     * @property Input
      * @description
      * A title that will be added to the passenger select dropdown.
      */
     passengerSelectTitle: string;
     /**
+     * @property Input
      * @description
      * A label for the adults passenger type in the passenger select dropdown.
      */
     passengerSelectAdultsLabel: string;
     /**
+     * @property Input
      * @description
      * A label for the children passenger type in the passenger select dropdown.
      */
     passengerSelectChildrenLabel: string;
     /**
+     * @property Input
      * @description
      * A label for the infants passenger type in the passenger select dropdown.
      */
     passengerSelectInfantsLabel: string;
     /**
+     * @property Input
      * @description
      * A label that will appear when total number of selected passengers exceeds the group booking limit
      */
     groupBookingLabel: string;
     /**
+     * @property Input
      * @description
      * A label that will appear on top of all airports in the airport select drop down lists.
      */
     allAirportsLabel: string;
     /**
+     * @property Input
      * @description
      * A label that will appear on top of the latest searches in the airport select drop down lists.
      */
     latestSearchesLabel: string;
     /**
+     * @property Input
      * @description
      * A label that will appear on top of the closest airports in the airport select drop down lists.
      */
     closestAirportsLabel: string;
     /**
+     * @property Input
      * @description
      * A label that will appear in the destination input field in the airport select, if the
      * user tries to select a destination airport without selecting an origin airport.
      */
     selectOriginFirstLabel: string;
     /**
+     * @property Input
      * @required
      * @description
      * A label that will appear on top of the origin airport input field.
      */
     labelOrigin: string;
     /**
+     * @property Input
      * @description
      * A placeholder that will appear on the origin airport input field.
      */
     placeholderOrigin: string;
     /**
+     * @property Input
      * @required
      * @description
      * A label that will appear on top of the destination airport input field.
      */
     labelDestination: string;
     /**
+     * @property Input
      * @description
      * A label that will appear in my location in the drop down list in airport select.
      */
     geolocationLabel: string;
     /**
+     * @property Input
      * @description
      * A label that will appear in my location, in the drop down list in airport select if user has denied geolocation.
      */
     geolocationBlockedLabel: string;
     /**
+     * @property Input
      * @description
      * A placeholder that will appear on the destination airport input field.
      */
     placeholderDestination: string;
     /**
+     * @property Input
      * @description
      * A modifier that will allow always keeping the selected airport.
      * The last selected airport will be shown once user clears the selection and blur.
      */
     keepSelection: boolean;
     /**
+     * @property Input
      * @description
      * A title that will be assigned to edit search accordion.
      */
     editSearchTitle: string;
     /**
+     * @property Input
      * @description
      * Adds the parent's form group.
      * It requires that the consumer included ReactiveFormsModule in it's module.
      * It is requiered to be filled if nasFormControlName added.
      */
-    nasFormGroup: UntypedFormGroup;
+    nasFormGroup: FormGroup;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -291,6 +333,7 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlNameOrigin: string;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -298,6 +341,7 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlNameDestination: string;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -305,6 +349,7 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlNameTripType: string;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -312,6 +357,7 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlNameDirectOnly: string;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -319,6 +365,7 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlNameOutbound: string;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -326,6 +373,7 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlNameInbound: string;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -333,6 +381,7 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlGroupBooking: string;
     /**
+     * @property Input
      * @description
      * Sets a formControlName directive to the input.
      * It requires that the consumer included ReactiveFormsModule in it's module.
@@ -340,11 +389,13 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
      */
     nasFormControlNameSubsidyDiscount: string;
     /**
+     * @property Input
      * @description
      * Make latest searches and geolocation override default value in the origin airport selector.
      */
     overrideOrigin?: boolean;
     /**
+     * @property Input
      * @description
      * This will make the filter display suggested airports based on geolocation and latest searches.
      */
@@ -352,10 +403,13 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
     get closestAirports(): Array<AirportModel>;
     set closestAirports(airports: Array<AirportModel>);
     /**
+     * @property Input
+     * @description
      * This will only display airport selection. When a city pair is selected, the rest of the filter will be visible.
      */
     minimize?: boolean;
     /**
+     * @property Input
      * @required
      * @description
      * All airports that will be populated into the dropdown lists.
@@ -364,270 +418,322 @@ export declare class FilterComponent extends NasComponentBase implements OnInit,
     get airports(): Array<AirportModel>;
     set airports(airports: Array<AirportModel>);
     /**
+     * @property Input
      * @description
      * Sets and gets the selected trip type.
      */
     get tripType(): TripType;
     set tripType(tripType: TripType);
     /**
+     * @property Input
      * @description
      * Sets and gets whether the selected transit type is direct only or not.
      */
     get directOnly(): boolean;
     set directOnly(directOnly: boolean);
     /**
+     * @property Input
      * @description
      * The limit for when the total amount of passengers exceeds to be a group booking.
      */
     groupBookingLimit: number;
     /**
+     * @property Input
      * @description
      * Subsidy discounts
      */
     subsidyDiscounts: Array<SubsidyDiscountModel>;
     /**
+     * @property Input
      * @description
      * Selected subsidy discount
      */
     selectedSubsidyDiscount: SubsidyDiscountModel;
     /**
+     * @property Input
      * @description
      * Subsidy discount label
      */
     subsidyDiscountLabel: string;
     /**
+     * @property Input
      * @description
      * ARIA label for the previous month button in the calendar.
      */
     ariaLabelPreviousMonth: string;
     /**
+     * @property Input
      * @description
      * ARIA label for the next month button in the calendar.
      */
     ariaLabelNextMonth: string;
     /**
+     * @property Output
      * @description
      * An event that is fired every time the origin dropdown selector opens or closes.
      */
     originOpenChange: EventEmitter<boolean>;
     /**
+    * @property Output
     * @description
     * An event that is fired every time the origin dropdown selector opens or closes.
     */
     destinationOpenChange: EventEmitter<boolean>;
     /**
+     * @property Output
      * @description
      * An event that is fired every time the passenger select dropdown opens or closes.
      */
     passengerSelectOpenChange: EventEmitter<boolean>;
     /**
+     * @property Output
      * @description
      * An event that is fired every time the selected origin airport changes.
      */
     originChange: EventEmitter<AirportModel>;
     /**
+    * @property Output
     * @description
     * An event that is fired every time the selected destination airport changes.
     */
     destinationChange: EventEmitter<AirportModel>;
     /**
+     * @property Output
      * @description
      * An event that is fired every time a passenger selection change is performed.
      */
     passengersChange: EventEmitter<PassengersModel[]>;
     /**
+     * @property Output
      * @description
      * Sets and gets the selected trip type.
      */
     tripTypeChange: EventEmitter<TripType>;
     /**
+     * @property Output
      * @description
      * Sets and gets whether the selected transit type is direct only or not.
      */
     directOnlyChange: EventEmitter<boolean>;
     /**
+     * @property Input
      * @description
      * Label for no available flights.
      */
     noAvailableFlightsLabel: string;
     /**
+     * @property Input
      * @description
      * Label for available flights.
      */
     availableFlightsLabel: string;
     /**
+     * @property Input
      * @description
      * Disable possibility to select dates in the past.
      */
     disablePastSelection: boolean;
     /**
+     * @property Input
      * @description
      * Label for outbound datepicker.
      */
     outboundLabel: string;
     /**
+     * @property Input
      * @description
      * Label for inbound datepicker.
      */
     inboundLabel: string;
     /**
+     * @property Input
      * @description
      * Sets the datepickers in availability mode where available dates can be added.
      */
     availability: boolean;
     /**
+     * @property Input
      * @description
      * Available dates for outbound calendar.
      */
     outboundAvailableDates: Array<UtcDate>;
     /**
+     * @property Input
      * @description
      * Available dates for inbound calendar.
      */
     inboundAvailableDates: Array<UtcDate>;
     /**
+     * @property Input
      * @description
      * If set, Enables the time dropdown selector alongside datepicker.
      */
     times: Array<UtcDate>;
     /**
+     * @property Input
      * @description
      * The display format of the date when user has selected the date and it is being shown in the input box for the date picker.
      * Please look at the angular Date pipe for valid formats and variations.
      */
     dateDisplayFormat: string;
     /**
+     * @property Input
      * @description
      * The time display format.
      */
     timeDisplayFormat: string;
     /**
+     * @property Input
      * @description
      * A locale code for the locale format rules to use. When not supplied, uses the value of LOCALE_ID, which is en-US by default.
      * This requires that registerLocaleData is called with the respective locale.
      */
     locale: string;
     /**
+     * @property Input
      * @description
      * A modifier to remove the padding and margins around the element.
      */
     compact: boolean;
     /**
+     * @property Input
      * @description
      * Disable possibility to select outbound dates.
      */
     outboundDisabled: boolean;
     /**
+     * @property Input
      * @description
      * Disable possibility to select inbound dates.
      */
     inboundDisabled: boolean;
     /**
+     * @property Input
      * @description
      * Show/Add date picker combo into the filter if set to true.
      */
     enableDatepickers: boolean;
     /**
+     * @property Input
      * @required
      * @description
      * Label for the toggle icon for minimizing filter.
      */
     minimizingLabel: string;
     /**
+     * @property Input
      * @required
      * @description
      * Label for the toggle icon for maximizing filter.
      */
     maximizingLabel: string;
     /**
+     * @property Input
      * @required
      * @description
      * Label for the toggling transit type when filter is minimized.
      */
     directOnlyMobileLabel: string;
     /**
+     * @property Input
      * @description
      * Label for 'or' in the suggestioned airports.
      */
     orLabel: string;
     /**
+     * @property Input
      * @description
      * A text that appears in the destinations dropdown list when origin airport is not set.
      */
     invalidDestinationText: string;
     /**
+     * @property Input
      * @description
      * Selected datefor outbound calendar.
      */
     get outboundSelectedDate(): UtcDate;
     set outboundSelectedDate(date: UtcDate);
     /**
+     * @property Input
      * @description
      * Selected datefor inbound calendar.
      */
     get inboundSelectedDate(): UtcDate;
     set inboundSelectedDate(date: UtcDate);
     /**
+     * @property Input
      * @description
      * Will display the destination input, set this to false to remove it. It's true by default.
      */
     enableDestinationSelect: boolean;
     /**
+     * @property Input
      * @description
      * Will display passenger select, set this to false to remove it. It's true by default.
      */
     enablePassengersSelect: boolean;
     /**
+     * @property Input
      * @description
      * Will display the trip switch, set this to false to remove it. It's true by default.
      */
     enableTripSwitch: boolean;
     /**
+     * @property Input
      * @description
      * Will display the transit switch, set this to false to remove it. It's true by default.
      */
     enableTransitSwitch: boolean;
     /**
+     * @property Output
      * @description
      * When selected datehas been changed on the outbound calendar.
      */
     outboundSelectedDateChange: EventEmitter<UtcDate>;
     /**
+     * @property Output
      * @description
      * When selected datehas been changed on the inbound calendar.
      */
     inboundSelectedDateChange: EventEmitter<UtcDate>;
     /**
+     * @property Output
      * @description
      * Outbound datepicker is open or closed.
      */
     outboundOpenChange: EventEmitter<boolean>;
     /**
+     * @property Output
      * @description
      * Inbound datepicker is open or closed.
      */
     inboundOpenChange: EventEmitter<boolean>;
     /**
+     * @property Output
      * @description
      * Outbound calendar changes month.
      */
     outboundMonthChange: EventEmitter<UtcDate>;
     /**
+     * @property Output
      * @description
      * Inbound calendar changes month.
      */
     inboundMonthChange: EventEmitter<UtcDate>;
     /**
+     * @property Output
      * @description
      * When a user has actively changed the date.
      */
     focusOnNextChange: EventEmitter<any>;
     /**
+     * @property Output
      * @description
      * The geolocation of the user. Will be emitted if 'enableSuggestions' is true.
      */
     positionChange: EventEmitter<GeolocationPosition>;
     /**
+     * @property Output
      * @description
      * An even that is fired every time the info button on the subsidy discount is clicked.
      */