AppBar

23 Sep 20254 minutes to read

The AppBar displays the information and actions related to the current application screen. It is used to show branding, screen titles, navigation, and actions.
Support to inherit colors from AppBar provided to Button, DropDownButton, Menu and TextBox.
Set CssClass property with e-inherit CSS class to inherit the background and color from AppBar.

Properties

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.

Defaults to ‘Light’

cssClass string

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

Defaults to null

enablePersistence boolean

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

Defaults to false

enableRtl boolean

Enable or disable rendering component in right to left direction.

Defaults to false

htmlAttributes Record

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

Defaults to null

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.

Defaults to false

locale string

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

Defaults to ’’

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.

Defaults to ‘Regular’

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.

Defaults to ‘Top’

Methods

addEventListener

Adds the handler to the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event
handler Function Specifies the call to run when the event occurs.

Returns void

appendTo

Appends the control within the given HTML element

Parameter Type Description
selector (optional) string | HTMLElement Target element where control needs to be appended

Returns void

attachUnloadEvent

Adding unload event to persist data when enable persistence true

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

Removes the control from the DOM and also removes all its related events.

Returns void

detachUnloadEvent

Removing unload event to persist data when enable persistence true

Returns void

getLocalData

Returns the persistence data for component

Returns any

getRootElement

Returns the route element of the component

Returns HTMLElement

handleUnload

Handling unload event to persist data when enable persistence true

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event to remove
handler Function Specifies the function to remove

Returns void

Inject

Dynamically injects the required modules to the component.

Parameter Type Description
moduleList Function[] ?

Returns void

Events

created EmitType<Event>

Triggers after the AppBar component is created.

destroyed EmitType<Event>

Triggers when the AppBar component is destroyed.