Makes elements remain at the top or bottom of the viewport, like a sticky navbar.
Basic Usage
Top positioning
Show editable code example
Any Paragon component or export may be added to the code example.
Bottom positioning
Show editable code example
Any Paragon component or export may be added to the code example.
With offset
Valid offset
values are the same as for the spacing classes.
Show editable code example
Any Paragon component or export may be added to the code example.
Theme Variables (SCSS)#
$sticky-offset: 0 !default;$sticky-shadow-top: 0 -.5rem 1rem rgba(0, 0, 0, .15), 0 -.25rem .625rem rgba(0, 0, 0, .15) !default;$sticky-shadow-bottom: 0 .5rem 1rem rgba(0, 0, 0, .15), 0 .25rem .625rem rgba(0, 0, 0, .15) !default;
Props API#
Sticky Props API
- children
node
RequiredSpecifies content of the component.
- position
enum
'top' | 'bottom'Default'top'Specifies position of the element.
- offset
number
|string
Specifies offset from top/bottom depending on the
position
property.Valid values are based on
the spacing classes
:0, 0.5, ... 6
. - className
string
Specifies an additional
className
to add to the base element.