RibbonModel API in JavaScript Ribbon API control

Interface for a class Ribbon

Properties

created

EmitType<Event>

Event triggers once the Ribbon Component rendering is completed.

launcherIconClick

EmitType<LauncherClickEventArgs>

Event triggers when the launcher icon of the group is clicked.

overflowPopupClose

EmitType<OverflowPopupEventArgs>

Event triggers when the overflow popup closes.

overflowPopupOpen

EmitType<OverflowPopupEventArgs>

Event triggers when the overflow popup opens.

ribbonCollapsing

EmitType<ExpandCollapseEventArgs>

Event triggers before collapsing the ribbon.

ribbonExpanding

EmitType<ExpandCollapseEventArgs>

Event triggers before expanding the ribbon.

tabSelected

EmitType<TabSelectedEventArgs>

Event triggers after selecting the tab item.

tabSelecting

EmitType<TabSelectingEventArgs>

Event triggers before selecting the tab item.

activeLayout

RibbonLayout | string

Specifies the active layout of the ribbon. Accepts one of the below values.

• Classic – Renders the ribbon tab contents in classic layout.
• Simplified – Renders the ribbon tab contents in single row.

backStageMenu

BackStageMenuModel

Defines the properties of ribbon backstage.

contextualTabs

RibbonContextualTabSettingsModel[]

Defines the properties of ribbon contextual tab.

cssClass

string

Defines one or more CSS classes to customize the appearance of ribbon.

enableKeyTips

boolean

Defines whether to enable the key tip or not.

enablePersistence

boolean

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

enableRtl

boolean

Enable or disable rendering component in right to left direction.

fileMenu

FileMenuSettingsModel

Defines the properties of ribbon file menu.

helpPaneTemplate

string | HTMLElement | Function

Specifies the template content for the help pane of ribbon. The help pane appears on the right side of the ribbon header row.

hideLayoutSwitcher

boolean

Defines whether to show the layout switcher button or not.

isMinimized

boolean

Specifies whether the ribbon is minimized or not. When minimized, only the tab header is shown.

launcherIconCss

string

Defines the icon CSS for the launcher icon button in group header.

layoutSwitcherKeyTip

string

Defines the key tip text for the layoutSwitcher icon.

locale

string

Provides the localization value for the controls present in ribbon items.

selectedTab

number

Specifies the index of the current active tab.

tabAnimation

TabAnimationSettingsModel

Specifies the animation configuration settings for showing the content of the Ribbon Tab.

tabs

RibbonTabModel[]

Defines the list of ribbon tabs.

width

string | number

Specifies the width of the ribbon.