ngx-breakpoint-observer
Version:
Angular reactive breakpoint observer based on Signals.
27 lines (26 loc) • 1.19 kB
TypeScript
import { type Signal } from '@angular/core';
import { Breakpoints, MaybeSignalOrGetter, ObserveBreakpointsOptions } from './types';
/**
* **@deprecated** Use `injectBreakpoints` instead.
*
* This function will be removed in version `4.0.0`.
*
* Reactive viewport breakpoints.
*
* @param breakpoints
* @param options
*/
export declare function observeBreakpoints<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>;
};