UNPKG

ngx-breakpoint-observer

Version:

Angular reactive breakpoint observer based on Signals.

24 lines (23 loc) 906 B
import { Signal } from '@angular/core'; export type Breakpoints<K extends string = string> = Record<K, number | string>; /** * Maybe it's a signal, or a plain value, or a getter function */ export type MaybeSignalOrGetter<T> = T | Signal<T> | (() => T); export interface ConfigurableWindow { /** * Specify a custom `window` instance, e.g. working with iframes or in testing environments. */ window?: Window; } export interface ObserveBreakpointsOptions extends ConfigurableWindow { /** * The query strategy to use for the generated shortcut methods like `.lg` * * 'min-width' - .lg will be true when the viewport is greater than or equal to the lg breakpoint (mobile-first) * 'max-width' - .lg will be true when the viewport is smaller than the xl breakpoint (desktop-first) * * @default "min-width" */ strategy?: 'min-width' | 'max-width'; }