IDisplayInstance
interface
Display & Responsive
Reactive display service — the object returned by useDisplay(). Exposes reactive breakpoint flags, current viewport dimensions, platform detection and an update() method for manual refresh.
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- xsrequisRef<boolean>
- True when the viewport is in the xs range.
- smrequisRef<boolean>
- True when the viewport is in the sm range.
- mdrequisRef<boolean>
- True when the viewport is in the md range.
- lgrequisRef<boolean>
- True when the viewport is in the lg range.
- xlrequisRef<boolean>
- True when the viewport is in the xl range.
- xxlrequisRef<boolean>
- True when the viewport is in the xxl range.
- smAndUprequisRef<boolean>
- True when viewport width >= sm threshold.
- mdAndUprequisRef<boolean>
- True when viewport width >= md threshold.
- lgAndUprequisRef<boolean>
- True when viewport width >= lg threshold.
- xlAndUprequisRef<boolean>
- True when viewport width >= xl threshold.
- smAndDownrequisRef<boolean>
- True when viewport width < md threshold.
- mdAndDownrequisRef<boolean>
- True when viewport width < lg threshold.
- lgAndDownrequisRef<boolean>
- True when viewport width < xl threshold.
- xlAndDownrequisRef<boolean>
- True when viewport width < xxl threshold.
- namerequisRef<TBreakpoint>
- Current active breakpoint name (xs | sm | md | lg | xl | xxl).
- heightrequisRef<number>
- Reactive viewport height in pixels.
- widthrequisRef<number>
- Reactive viewport width in pixels.
- mobilerequisRef<boolean>
- True when the current breakpoint is at or below the configured mobileBreakpoint.
- mobileBreakpointrequisRef<number | TBreakpoint>
- Active mobile breakpoint value (reactive).
- platformrequisRef<IDisplayPlatform>
- Reactive platform detection snapshot.
- thresholdsrequisRef<TDisplayThresholds>
- Reactive named breakpoint thresholds in pixels.
- ssrrequisboolean
- Static flag indicating server-side rendering context (non-reactive).
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Consuming the display instance in a component