ngx-breakpoint-observer/lib/inject-breakpoints.d.ts

Angular reactive breakpoint observer based on Signals.

import { Signal } from '@angular/core';
import { Breakpoints, MaybeSignalOrGetter, ObserveBreakpointsOptions } from './types';
/**
 * Reactive viewport breakpoints.
 *
 * This function provides a set of reactive utilities to handle viewport breakpoints.
 * It includes shortcut methods like `greaterOrEqual`, `smallerOrEqual`, `between`, etc.
 *
 * @param breakpoints A map of breakpoint names and their corresponding values.
 * @param options Configuration options such as window and strategy.
 * @returns An object with breakpoint utilities and shortcut methods.
 */
export declare function injectBreakpoints<K extends string>(breakpoints: Breakpoints<K>, options?: ObserveBreakpointsOptions): Record<K, Signal<boolean>> & {
    greaterOrEqual: (k: MaybeSignalOrGetter<K>) => Signal<boolean>;
    smallerOrEqual: (k: MaybeSignalOrGetter<K>) => Signal<boolean>;
    greater(k: MaybeSignalOrGetter<K>): Signal<boolean>;
    smaller(k: MaybeSignalOrGetter<K>): Signal<boolean>;
    between(a: MaybeSignalOrGetter<K>, b: MaybeSignalOrGetter<K>): Signal<boolean>;
    isGreater(k: MaybeSignalOrGetter<K>): boolean;
    isGreaterOrEqual(k: MaybeSignalOrGetter<K>): boolean;
    isSmaller(k: MaybeSignalOrGetter<K>): boolean;
    isSmallerOrEqual(k: MaybeSignalOrGetter<K>): boolean;
    isInBetween(a: MaybeSignalOrGetter<K>, b: MaybeSignalOrGetter<K>): boolean;
    current: () => Signal<string[]>;
    active(): Signal<string>;
};