IBottomNavProps

interface
Component Props

Props contract for <OrigamBottomNav> — a fixed navigation bar with item buttons, supporting grow mode, placement position, transition, and the full cross-cutting surface (color, bgColor, border, elevation, margin, dimension, density, rounded, layout, group, hover, active).

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

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.

grow
boolean
Make each item button grow to fill the available width equally.
mode
TNavMode
Display mode of the bottom nav bar.
items
Array<IBtnProps>
Array of button props used to render nav items declaratively.
position
TBottomNavPosition
'start'
Horizontal placement of the bar when it does not span the full width: start (inline-start), center or end (inline-end).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Declarative bottom nav with grow items

html