Typed choices¶

PyReveal uses Python enums for common string options. Your editor can autocomplete them, and invalid values raise a clear error listing valid choices.

Plain strings still work (theme="dracula"), but enums are preferred.

Import¶

from pyreveal import (
    BackgroundSize,
    BackgroundType,
    CustomPlugin,
    FragmentEffect,
    MathEngine,
    Plugin,
    ScrollLayout,
    ScrollSnap,
    SlideNumber,
    KeyboardBinding,
    SlideVisibility,
    Theme,
    Transition,
    View,
)

Theme¶

Deck CSS theme: Presentation(theme=…) and set_theme().

Presentation("Talk", theme=Theme.DRACULA)

Transition¶

Slide transition: Presentation(transition=…), set_transition(), or per-slide transition.

Presentation("Talk", transition=Transition.FADE)

NONE, SLIDE, FADE, CONVEX, CONCAVE, ZOOM

Plugin¶

Reveal.js plugins: plugins() / enable_plugins().

deck.plugins(Plugin.NOTES, Plugin.HIGHLIGHT, Plugin.MATH)

MathEngine¶

Math renderer when Plugin.MATH is enabled.

deck.plugins(Plugin.MATH, math_engine=MathEngine.KATEX)

KATEX, MATHJAX2, MATHJAX3, MATHJAX4

BackgroundType¶

Explicit background kind in bg() dicts.

slide.bg(type=BackgroundType.IMAGE, image="bg.jpg", size=BackgroundSize.COVER)

COLOR, GRADIENT, IMAGE, VIDEO, IFRAME

BackgroundSize¶

Common image background sizes. Custom strings (e.g. "100px") still work.

COVER, CONTAIN

SlideVisibility¶

Per-slide visibility attribute.

Slide(visibility=SlideVisibility.HIDDEN)

View¶

Presentation layout mode for configure(view=…) and helpers like scroll_view().

deck.scroll_view()  # preferred over configure(view=View.SCROLL)
deck.print_view()

SlideNumber¶

Slide number format for slide_numbers().

deck.slide_numbers(SlideNumber.C_SLASH_T)
deck.slide_numbers(False)  # hide numbers

ScrollLayout / ScrollSnap¶

Used by scroll_view().

ScrollLayout: FULL, COMPACT

ScrollSnap: PROXIMITY, MANDATORY (or pass snap=False)

CustomPlugin¶

Register third-party plugin scripts:

CustomPlugin("assets/my-plugin.js", "RevealMyPlugin")

KeyboardBinding¶

Reveal.js API actions for keyboard_bindings(). Pass None to disable a key.

from pyreveal import KeyboardBinding, Presentation

deck.keyboard_bindings({13: KeyboardBinding.NEXT, 32: None})

NEXT, PREV, LEFT, RIGHT, UP, DOWN, TOGGLE_PAUSE, TOGGLE_HELP, TOGGLE_OVERVIEW, TOGGLE_AUTO_SLIDE, TOGGLE_JUMP_TO_SLIDE, PREV_FRAGMENT, NEXT_FRAGMENT

FragmentEffect¶

Fragment animation: slide.fragment(…, effect=…).

slide.fragment("Demo", effect=FragmentEffect.GROW)
slide.fragment("Highlight", effect=FragmentEffect.FADE_UP)