SolidAboutConfig class

Configuration for About dialog functionality in the Solid scaffold.

Constructors

SolidAboutConfig({bool enabled = true, IconData? icon, String? applicationName, String? applicationVersion, Widget? applicationIcon, String? applicationLegalese, String? text, Widget? customContent, List<Widget>? children, bool showOnNarrowScreen = true, bool showOnVeryNarrowScreen = true, int priority = 999, String? tooltip, VoidCallback? onPressed, bool showLayoutPreferences = true, bool showMenuLayoutPreferences = true, bool scaffoldMenuInBottomBar = true, SolidInviteOthersConfig? inviteConfig, SolidFeedbackConfig? feedbackConfig, String? readmeUrl})
const

Properties

applicationIcon → Widget?
Application icon displayed in the About dialogue.
final
applicationLegalese → String?
Application legal notice (usually copyright information).
final
applicationName → String?
Application name displayed in the About dialogue.
final
applicationVersion → String?
Application version displayed in the About dialogue.
final
children → List<Widget>?
Additional children widgets to be shown in the About dialogue. Note: If 'text' is provided, it takes precedence over 'children'.
final
customContent → Widget?
Custom About dialogue content. If provided, this replaces the default dialogue.
final
effectiveIcon → IconData
Returns the icon to display for the About button.
no setter
effectiveTooltip → String
Returns the tooltip text for the About button.
no setter
enabled → bool
Whether the About button is enabled.
final
feedbackConfig → SolidFeedbackConfig?
Optional Feedback configuration. When supplied, a Feedback button is added to the About dialogue alongside the AppBar and Share buttons. If null, a greyed-out placeholder is shown so the dialogue layout stays consistent and applications retain a clear integration point for a future feedback flow.
final
hashCode → int
The hash code for this object.
no setterinherited
icon → IconData?
Custom icon for the About button (defaults to info icon).
final
inviteConfig → SolidInviteOthersConfig?
Optional Invite Others configuration. When supplied, a Share button is added to the About dialogue so users can invite people directly from the App Info page.
final
onPressed → VoidCallback?
Callback when About button is pressed. If null, shows default About dialogue.
final
priority → int
Priority for ordering in AppBar actions (higher numbers appear later).
final
readmeUrl → String?
Optional URL for the application README. When provided, a README button is added to the About dialogue action row. The URL is opened in the system browser. Typically the raw GitHub README URL or a documentation page, e.g.:
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldMenuInBottomBar → bool
Default for bottom-bar menu layout before the user saves a preference.
final
showLayoutPreferences → bool
Whether to show Layout Preferences button in the About dialogue. Defaults to true, allowing users to configure AppBar button layout.
final
showMenuLayoutPreferences → bool
Whether to show the Menu layout button in the About dialogue.
final
showOnNarrowScreen → bool
Whether to show the About button on narrow screens.
final
showOnVeryNarrowScreen → bool
Whether to show the About button on very narrow screens.
final
text → String?
Main text content for the About dialogue (supports Markdown). If provided, this will be rendered as MarkdownBody with word wrapping.
final
tooltip → String?
Tooltip text for the About button.
final

Methods

copyWith({bool? enabled, IconData? icon, String? applicationName, String? applicationVersion, Widget? applicationIcon, String? applicationLegalese, String? text, Widget? customContent, List<Widget>? children, bool? showOnNarrowScreen, bool? showOnVeryNarrowScreen, int? priority, String? tooltip, VoidCallback? onPressed, bool? showLayoutPreferences, bool? showMenuLayoutPreferences, bool? scaffoldMenuInBottomBar, SolidInviteOthersConfig? inviteConfig, SolidFeedbackConfig? feedbackConfig, String? readmeUrl}) → SolidAboutConfig
Returns a copy of this configuration with the supplied fields overridden. Useful for layering an inviteConfig from the scaffold onto an SolidAboutConfig supplied by the application.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shouldShow(double screenWidth, double narrowThreshold, double veryNarrowThreshold) → bool
Returns whether to show the About button based on screen width.
toString() → String
A string representation of this object.
inherited

Operators

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