RebrandConfig class
Configuration model for the Rebrand CLI tool.
This class holds all the necessary configuration data required to rebrand a Flutter application, including app name, package identifier, icon assets, and splash screen settings.
The configuration is typically loaded from a rebrand_config.json file
located in the root of the Flutter project.
Example JSON structure:
{
"app_name": "My New App",
"package_name": "com.newcompany.app",
"icon_path": "assets/logo.png",
"splash_config": {
"color": "#FFFFFF",
"image": "assets/logo.png",
"dark_color": "#111111"
}
}
Constructors
-
RebrandConfig({String? appName, String? packageName, String? iconPath, Map<
String, dynamic> ? splash, double splashScreenScale = 0.65, bool enableSplash = true, bool enableLauncherIcon = true, bool enablePackageRename = true, bool enableAppLabel = true, bool enableAndroid = true, bool enableIOS = true}) - Creates a new RebrandConfig instance.
-
RebrandConfig.fromJson(Map<
String, dynamic> json) -
Creates a RebrandConfig instance from a JSON map.
factory
Properties
- android12Branding → String?
-
no setter
- android12BrandingDark → String?
-
no setter
- android12Color → String
-
no setter
- android12DarkColor → String?
-
no setter
- android12DarkImagePath → String?
-
no setter
- android12IconBackgroundColor → String?
-
no setter
- android12IconBackgroundDarkColor → String?
-
no setter
- android12ImagePath → String?
-
no setter
-
android12SplashConfig
→ Map<
String, dynamic> -
no setter
- appName → String?
-
The display name of the application.
final
- enableAndroid → bool
-
Whether to enable rebranding for Android.
final
- enableAppLabel → bool
-
Whether to update the app label (App Name).
final
- enableIOS → bool
-
Whether to enable rebranding for iOS.
final
- enableLauncherIcon → bool
-
Whether to generate launcher icons.
final
- enablePackageRename → bool
-
Whether to rename the package (Bundle ID).
final
- enableSplash → bool
-
Whether to generate the splash screen.
final
- hasEnabledActions → bool
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- iconPath → String?
-
Path to the app icon image file.
final
- packageName → String?
-
The unique package identifier for the application.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
splash
→ Map<
String, dynamic> ? -
Splash screen configuration settings.
final
- splashAndroidScreenOrientation → String?
-
no setter
- splashAutoPad → bool
-
no setter
- splashBranding → String?
-
no setter
- splashBrandingBottomPadding → int?
-
no setter
- splashBrandingDark → String?
-
no setter
- splashBrandingMode → String?
-
no setter
- splashColor → String
-
no setter
-
splashConfig
→ Map<
String, dynamic> -
no setter
- splashDarkColor → String?
-
no setter
- splashDarkImagePath → String?
-
no setter
- splashFullscreen → bool
-
no setter
- splashGravity → String
-
no setter
- splashImagePath → String?
-
no setter
- splashIOSContentMode → String
-
no setter
- splashScreenScale → double
-
Scale factor for the splash screen image (0.0 to 1.0).
final
- splashWebImageMode → String?
-
no setter
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited