kslides-core/com.kslides.config/MenuConfig

MenuConfig

class MenuConfig : AbstractConfig

Configuration for the reveal.js menu plugin. Only takes effect when PresentationConfig.enableMenu is true.

Constructors

MenuConfig

constructor()

Properties

autoOpen

var autoOpen: Boolean

When true, menu panels auto-open during keyboard navigation. Only applies when both keyboard and sticky are enabled.

custom

var custom: Boolean

Enable support for custom menu panels. See the menu plugin's docs for the panel shape.

delayInit

var delayInit: Boolean

When true, the menu is not created until RevealMenu.init() is called manually. Defers creation of all panels and the open button.

hideMissingTitles

var hideMissingTitles: Boolean

When true, slides without any resolvable title are omitted from the menu entirely.

keyboard

var keyboard: Boolean

When true, the user can open and navigate the menu with the keyboard. Reveal.js keyboard shortcuts are suspended while the menu is open.

kslidesManagedValues

val kslidesManagedValues: MutableMap<String, Any>

Values consumed by kslides itself (theme, highlight plugin, corner links, iframe sizing, etc.).

loadIcons

var loadIcons: Boolean

When true (the default), the menu plugin auto-loads Font Awesome. Set to false if your presentation already loads Font Awesome to avoid a duplicate fetch.

markers

var markers: Boolean

When true, show visited / current-slide progress markers next to menu items.

numbers

var numbers: Boolean

When true, add slide numbers to the titles in the menu list.

openButton

var openButton: Boolean

When true, render a hamburger button on the slides to open the menu.

openOnInit

var openOnInit: Boolean

When true, the menu is visible immediately after initialization.

openSlideNumber

var openSlideNumber: Boolean

When true, clicking the slide number opens the menu. Requires PresentationConfig.slideNumber to be enabled.

revealjsManagedValues

val revealjsManagedValues: MutableMap<String, Any>

Values that correspond to documented reveal.js config options.

side

var side: String

Side of the viewport the menu opens from. "left" or "right".

sticky

var sticky: Boolean

When true, the menu stays open until explicitly closed (Esc or the m key when keyboard is on). Otherwise normal user actions dismiss it.

themes

var themes: Boolean

Enable the themes menu panel. true uses the default theme list; pass a custom theme list via revealjsManagedValues directly for non-trivial setups.

themesPath

var themesPath: String

Base directory for the default theme CSS files. Only used when themes is true and no custom list is provided.

titleSelector

var titleSelector: String

CSS selector used to extract a slide's title. Defaults to the first heading (h1, h2, h3, h4, h5, h6). A data-menu-title attribute or an element with class="menu-title" on a slide takes precedence.

transitions

var transitions: Boolean

Enable the transitions menu panel.

useTextContentForMissingTitles

var useTextContentForMissingTitles: Boolean

When true, slides without a matching title selector fall back to using the first bit of text content as the menu label.

width

var width: String

Menu width. Accepts a named size ("normal", "wide", "third", "half", "full") or any valid CSS length.

Functions

merge

fun merge(other: AbstractConfig)

Copy all entries from other's maps into this config's maps. Later puts overwrite earlier ones.