@koobiq/components 20.4.2 → 21.0.0

package/types/koobiq-components-search-expandable.d.ts

@@ -0,0 +1,164 @@
+import * as _angular_core from '@angular/core';
+import { InjectionToken, OnChanges, AfterViewInit, AfterViewChecked, OnDestroy, DestroyRef, SimpleChanges, Provider } from '@angular/core';
+import * as _koobiq_components_core from '@koobiq/components/core';
+import { KbqSearchExpandableLocaleConfiguration, ErrorStateMatcher, KbqDeepPartial } from '@koobiq/components/core';
+import { FocusMonitor } from '@angular/cdk/a11y';
+import { ControlValueAccessor, NgControl, FormControl } from '@angular/forms';
+
+/** default configuration of search-expandable */
+declare const KBQ_SEARCH_EXPANDABLE_DEFAULT_LOCALE_CONFIGURATION: KbqSearchExpandableLocaleConfiguration;
+/** Injection Token for providing configuration of search-expandable */
+declare const KBQ_SEARCH_EXPANDABLE_LOCALE_CONFIGURATION: InjectionToken<KbqSearchExpandableLocaleConfiguration>;
+/**
+ * Utility provider for `KBQ_SEARCH_EXPANDABLE_LOCALE_CONFIGURATION`. Only the strings you pass are overridden; the
+ * rest keep following the active locale.
+ */
+declare const kbqSearchExpandableLocaleConfigurationProvider: (configuration: KbqDeepPartial<KbqSearchExpandableLocaleConfiguration>) => Provider;
+/** @deprecated Use {@link KBQ_SEARCH_EXPANDABLE_DEFAULT_LOCALE_CONFIGURATION}. Will be removed in 22.0.0. */
+declare const KBQ_SEARCH_EXPANDABLE_DEFAULT_CONFIGURATION: KbqSearchExpandableLocaleConfiguration;
+/** @deprecated Use {@link KBQ_SEARCH_EXPANDABLE_LOCALE_CONFIGURATION}. Will be removed in 22.0.0. */
+declare const KBQ_SEARCH_EXPANDABLE_CONFIGURATION: InjectionToken<KbqSearchExpandableLocaleConfiguration>;
+declare const defaultValue = "";
+declare const defaultEmitValueTimeout = 200;
+declare class KbqSearchExpandable implements OnChanges, ControlValueAccessor, AfterViewInit, AfterViewChecked, OnDestroy {
+    /** @docs-private */
+    protected readonly ngControl: NgControl | null;
+    /** @docs-private */
+    protected readonly focusMonitor: FocusMonitor;
+    /** @docs-private */
+    protected readonly destroyRef: DestroyRef;
+    /** @docs-private */
+    protected readonly nativeElement: HTMLElement;
+    private readonly carrier;
+    /**
+     * Accessible names of the icon-only controls this component renders itself.
+     *
+     * @docs-private
+     */
+    protected readonly a11yLocaleConfiguration: _angular_core.Signal<_koobiq_components_core.KbqA11yLocaleConfiguration>;
+    /** Strings currently rendered by the component. */
+    readonly localeConfiguration: _angular_core.Signal<KbqSearchExpandableLocaleConfiguration>;
+    private readonly input;
+    private readonly button;
+    private readonly tooltip;
+    /** @docs-private */
+    /**
+     * Control backing the expanded input. Owning it — rather than binding the consumer's own control to
+     * the input — keeps every write to the consumer's model going through the debounced pipeline below,
+     * and keeps a programmatic write from being echoed back as a user edit.
+     *
+     * @docs-private
+     */
+    protected readonly control: FormControl<string>;
+    /**
+     * Keeps the field's invalid state — and the `aria-invalid` derived from it — following the bound
+     * control, which is the only one the consumer's validators run on.
+     *
+     * @docs-private
+     */
+    protected readonly errorStateMatcher: ErrorStateMatcher;
+    /** Icon of the collapsed button and of the expanded field's prefix. */
+    protected readonly searchIconName = "kbq-magnifying-glass_16";
+    /** Current value in input. A write reaches the field, and the bound control once `emitValueTimeout` passes. */
+    readonly value: _angular_core.WritableSignal<string>;
+    protected lastFocusOrigin: 'touch' | 'mouse' | 'keyboard' | 'program' | null;
+    /** Suppress the automatic input focus once — set when the component auto-opens from a model value. */
+    private suppressInputFocus;
+    /** Whether the expanded input was rendered on the previous change detection pass. */
+    private inputRendered;
+    /** Whether the collapsed button was rendered on the previous change detection pass. */
+    private buttonRendered;
+    /** Cancels a pending debounced emission once the value has been emitted (or reset) through another path. */
+    private readonly cancelPendingEmit;
+    private focusMonitorSubscription;
+    /** state of component. */
+    get isOpened(): boolean;
+    set isOpened(value: boolean);
+    private readonly openedState;
+    /** Emit event by enter or not. Default is false */
+    readonly isEmitValueByEnterEnabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /** Timeout in milliseconds for emit event. The default value is taken from defaultEmitValueTimeout */
+    readonly emitValueTimeout: _angular_core.InputSignalWithTransform<number, unknown>;
+    /** Tooltip text for the search button. When set, overrides the locale tooltip */
+    get tooltipText(): string;
+    set tooltipText(value: string | null);
+    private _tooltipText;
+    /** Placeholder for input when expanded */
+    get placeholder(): string;
+    set placeholder(value: string | null);
+    private _placeholder;
+    /** Whether the component is disabled. Also set by the bound control through `setDisabledState`. */
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    private readonly disabledState;
+    /** Tab index of the collapsed button and of the expanded input. Always `-1` while disabled. */
+    get tabIndex(): number;
+    set tabIndex(value: number);
+    private _tabIndex;
+    /** Event emitted when the search has been toggled. */
+    readonly isOpenedChange: _angular_core.OutputEmitterRef<boolean>;
+    private lastEmittedValue;
+    /** @docs-private */
+    readonly isOpenedInput: _angular_core.InputSignalWithTransform<boolean | undefined, string | boolean | null | undefined>;
+    /** @docs-private */
+    readonly tooltipTextInput: _angular_core.InputSignal<string | null | undefined>;
+    /** @docs-private */
+    readonly placeholderInput: _angular_core.InputSignal<string | null | undefined>;
+    /** @docs-private */
+    readonly disabledInput: _angular_core.InputSignalWithTransform<boolean | undefined, string | boolean | null | undefined>;
+    /** @docs-private */
+    readonly tabIndexInput: _angular_core.InputSignalWithTransform<number | undefined, string | number | null | undefined>;
+    ngOnChanges(changes: SimpleChanges): void;
+    constructor();
+    ngAfterViewInit(): void;
+    /**
+     * Focus handoffs: the input takes focus when the field expands, the collapsed button takes it back
+     * when the field closes.
+     *
+     * This runs from `ngAfterViewChecked` rather than from an `effect()` on the queries, because view
+     * effects are flushed *before* view queries are refreshed within a change detection pass — an
+     * effect would always move focus one pass late.
+     *
+     * @docs-private
+     */
+    ngAfterViewChecked(): void;
+    ngOnDestroy(): void;
+    /** @docs-private */
+    onChange: (value: string) => void;
+    /** @docs-private */
+    onTouch: () => void;
+    /** Implemented as part of ControlValueAccessor. */
+    registerOnChange(fn: (value: string) => void): void;
+    /** Implemented as part of ControlValueAccessor. */
+    registerOnTouched(fn: () => void): void;
+    /** Implemented as part of ControlValueAccessor. */
+    writeValue(value: string): void;
+    /** Body of `writeValue()`. */
+    private applyValue;
+    /** Implemented as part of ControlValueAccessor. */
+    setDisabledState(isDisabled: boolean): void;
+    toggle(): void;
+    /**
+     * Emits the typed value straight away when `isEmitValueByEnterEnabled` is set — the only path that
+     * emits in that mode, since the debounced pipeline is filtered out.
+     *
+     * @docs-private
+     */
+    protected onEnter(event: Event): void;
+    private setOpened;
+    /** Moves focus back onto the collapsed button, keeping its tooltip from opening on the way. */
+    private restoreFocusToButton;
+    private emitValue;
+    private runFocusMonitor;
+    private stopFocusMonitor;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<KbqSearchExpandable, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<KbqSearchExpandable, "kbq-search-expandable", never, { "isEmitValueByEnterEnabled": { "alias": "isEmitValueByEnterEnabled"; "required": false; "isSignal": true; }; "emitValueTimeout": { "alias": "emitValueTimeout"; "required": false; "isSignal": true; }; "isOpenedInput": { "alias": "isOpened"; "required": false; "isSignal": true; }; "tooltipTextInput": { "alias": "tooltipText"; "required": false; "isSignal": true; }; "placeholderInput": { "alias": "placeholder"; "required": false; "isSignal": true; }; "disabledInput": { "alias": "disabled"; "required": false; "isSignal": true; }; "tabIndexInput": { "alias": "tabIndex"; "required": false; "isSignal": true; }; }, { "isOpenedChange": "isOpenedChange"; }, never, never, true, [{ directive: typeof _koobiq_components_core.KbqLocaleOverridesDirective; inputs: { "kbqLocaleOverrides": "localeOverrides"; }; outputs: {}; }]>;
+}
+
+declare class KbqSearchExpandableModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<KbqSearchExpandableModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<KbqSearchExpandableModule, never, [typeof KbqSearchExpandable], [typeof KbqSearchExpandable]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<KbqSearchExpandableModule>;
+}
+
+export { KBQ_SEARCH_EXPANDABLE_CONFIGURATION, KBQ_SEARCH_EXPANDABLE_DEFAULT_CONFIGURATION, KBQ_SEARCH_EXPANDABLE_DEFAULT_LOCALE_CONFIGURATION, KBQ_SEARCH_EXPANDABLE_LOCALE_CONFIGURATION, KbqSearchExpandable, KbqSearchExpandableModule, defaultEmitValueTimeout, defaultValue, kbqSearchExpandableLocaleConfigurationProvider };