ChangelogOverlayConfig class

Configuration options for the What's New changelog announcement modal.

Controls copy, max displayed entries, and call-to-action button labels.

Example

const overlayConfig = ChangelogOverlayConfig(
  title: "What's New in Version 2.0",
  subtitle: "Check out our latest improvements!",
  entryCount: 5,
  primaryButton: "Got It",
);

Constructors

ChangelogOverlayConfig({String title = "What's New", String subtitle = '', int entryCount = 3, String primaryButton = 'Continue', String closeButton = 'Close'})
Creates a ChangelogOverlayConfig with customizable modal options.
const
ChangelogOverlayConfig.fromJson(Map<String, dynamic>? json)
Deserializes ChangelogOverlayConfig from a nullable JSON map.
factory

Properties

clampedEntryCount → int
Entry count clamped to a safe range of 1 to 10 entries.
no setter
closeButton → String
Label for the secondary close button (if displayed).
final
entryCount → int
Number of recent changelog entries to display in the modal.
final
hashCode → int
The hash code for this object.
no setterinherited
primaryButton → String
Label for the primary action button.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subtitle → String
Optional descriptive subtitle text.
final
title → String
Header title shown at the top of the announcement modal.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes ChangelogOverlayConfig to a JSON map.
toString() → String
A string representation of this object.
inherited

Operators

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