IScrollProps
interface
Scroll
Scroll-aware behaviour props for AppBar and similar layout components. Declares the scroll target, threshold and a space-separated list of behaviours (hide, collapse, elevate, fade-image, inverted).
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.
- scrollBehaviorTScrollBehavior | TAnyString
- Space-separated list of scroll behaviours, e.g. "hide inverted" or "elevate active". The inverted modifier flips the trigger direction for hide / collapse / elevate and does nothing on its own.
- scrollTargetstring
- CSS selector or element ID of the scroll container to observe. Defaults to the nearest scrollable ancestor when omitted.
- scrollThresholdstring | number
- Scroll distance (in pixels) the target must travel before the behaviour activates. Accepts a number or a CSS length string.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
AppBar hiding on scroll with a threshold