AppBarModel

23 Sep 20251 minute to read

Interface for a class AppBar

Properties

created EmitType<Event>

Triggers after the AppBar component is created.

destroyed EmitType<Event>

Triggers when the AppBar component is destroyed.

colorMode AppBarColor

Specifies the color mode that defines the color of the AppBar component. The possible values for this property are as follows:

  • Light: Specifies the AppBar in light color.
  • Dark: Specifies the AppBar in dark color.
  • Primary: Specifies the AppBar in a primary color.
  • Inherit: Inherit color from parent for AppBar. AppBar background and colors are inherited from its parent element.

cssClass string

Accepts single/multiple CSS classes (separated by a space) to be used for AppBar customization.

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

enableRtl boolean

Enable or disable rendering component in right to left direction.

htmlAttributes Record

Accepts HTML attributes/custom attributes that will be applied to the AppBar element.

isSticky boolean

Defines whether the AppBar position is fixed or not while scrolling the page.
When set to true, the AppBar will be sticky while scrolling.

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

mode AppBarMode

Specifies the mode of the AppBar that defines the AppBar height. The possible values for this property are as follows:

  • Regular: Specifies default height for the AppBar.
  • Prominent: Specifies longer height for the AppBar to show the longer titles and images, or to provide a stronger presence.
  • Dense: Specifies compressed (short) height for the AppBar to accommodate all the app bar content in a denser layout.

position AppBarPosition

Specifies the position of the AppBar. The possible values for this property are as follows:

  • Top: Position the AppBar at the top.
  • Bottom: Position the AppBar at the bottom.