MilibrisUIConfig class

UI configuration for the Milibris reader.

Pass to FlutterMilibris.open to customise the reader appearance and behaviour. Each field corresponds to a config section from the SDK docs. All fields are optional — omit a section to keep the SDK's defaults.

Fields marked iOS only have no runtime effect on Android. Fields marked Android only have no runtime effect on iOS. Fields with no platform annotation apply to both platforms.

Android visual theming (colors, fonts) requires XML resource overrides in the host app. See the android_config.md reference for resource names.

Constructors

MilibrisUIConfig({ReaderUIConfig? reader, NavigationBarUIConfig? navigationBar, SummaryUIConfig? summary, ArticleReaderUIConfig? articleReader, ArticleSettingsUIConfig? articleSettings, ReaderTutorialUIConfig? readerTutorial, SlideshowBoxUIConfig? slideshowBox, AlertUIConfig? alert, MiniSummaryUIConfig? miniSummary, ArticleImageUIConfig? articleImage, HtmlBoxUIConfig? htmlBox, ModalUIConfig? modal})
Creates a Milibris UI config.
const

Properties

alert → AlertUIConfig?
Alert popins.
final
articleImage → ArticleImageUIConfig?
The full-screen image viewer. iOS only.
final
articleReader → ArticleReaderUIConfig?
The in-article reader.
final
articleSettings → ArticleSettingsUIConfig?
The font/brightness settings panel. iOS only.
final
hashCode → int
The hash code for this object.
no setterinherited
htmlBox → HtmlBoxUIConfig?
HTML media boxes. iOS only.
final
miniSummary → MiniSummaryUIConfig?
The mini summary bottom sheet. Android only.
final
Modal screens (e.g. search). iOS only.
final
The reader navigation bar.
final
reader → ReaderUIConfig?
Top-level reader feature flags and colours.
final
readerTutorial → ReaderTutorialUIConfig?
The onboarding tutorial.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slideshowBox → SlideshowBoxUIConfig?
Slideshow media boxes.
final
summary → SummaryUIConfig?
The full-screen article summary.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
Serializes this config to a map for cross-platform transport.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited