IAppBarProps
interface
Component Props
Props for <OrigamAppBar> — a docked layout item that extends IToolbarProps (minus width/minWidth/maxWidth/floating) and ILayoutItemProps (minus absolute), plus scroll-driven behaviour and block-axis placement.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- locationTBlock
- Block-axis edge where the bar is docked. Accepts "top" or "bottom". Defaults to "top".
- imageIImgProps
- Background image for the app bar surface. Accepts an IImgProps descriptor (src, srcset, lazy-src, etc.).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
App bar docked at the bottom with elevation