Migrate colors and icons variables to Enums (#4180)

* icons as Enum

* colors as Enum

* sort __init__.py imports

* add random_color and random_icon methods for backwards compatibility

* update typing of color properties to use ColorValue

* create MaterialColors and CupertinoColors

* create test_colors.py

* create MaterialIcons and CupertinoIcons

* update typing of icon properties to use IconValue

* update icon/colors tests

* refactor ColorValue and IconValue

* Merge 'main' branch

* fix failing CI: ColorEnums and IconEnums as tuples (for isinstance checks in lower python versions)

* rename MaterialIcons to Icons and MaterialColors to Colors | add deprecation warning

* improve Control.copy_attrs

Author: ndonkoHenri

packages/flet/lib/src/controls/tabs.dart

@@ -201,12 +201,12 @@ class _TabsControlState extends State<TabsControl>
 
           var tabs = viewModel.controlViews.map((tabView) {
             var iconString = parseIcon(tabView.control.attrString("icon"));
-            var iconContentCtrls = tabView.children
-                .where((c) => c.name == "icon_content" && c.isVisible);
+            var iconCtrls = tabView.children
+                .where((c) => c.name == "icon" && c.isVisible);
 
-            var icon = iconContentCtrls.isNotEmpty
+            var icon = iconCtrls.isNotEmpty
                 ? createControl(
-                    widget.control, iconContentCtrls.first.id, disabled,
+                    widget.control, iconCtrls.first.id, disabled,
                     parentAdaptive: adaptive)
                 : iconString != null
                     ? Icon(iconString)

sdk/python/packages/flet-core/src/flet_core/__init__.py

@@ -5,11 +5,7 @@
     border,
     border_radius,
     canvas,
-    colors,
-    cupertino_colors,
-    cupertino_icons,
     dropdown,
-    icons,
     margin,
     padding,
     painting,
@@ -93,6 +89,7 @@
 from flet_core.checkbox import Checkbox
 from flet_core.chip import Chip
 from flet_core.circle_avatar import CircleAvatar
+from flet_core.colors import Colors, colors
 from flet_core.column import Column
 from flet_core.container import Container, ContainerTapEvent
 from flet_core.control import Control
@@ -105,6 +102,7 @@
 from flet_core.cupertino_bottom_sheet import CupertinoBottomSheet
 from flet_core.cupertino_button import CupertinoButton
 from flet_core.cupertino_checkbox import CupertinoCheckbox
+from flet_core.cupertino_colors import CupertinoColors, cupertino_colors
 from flet_core.cupertino_context_menu import CupertinoContextMenu
 from flet_core.cupertino_context_menu_action import CupertinoContextMenuAction
 from flet_core.cupertino_date_picker import (
@@ -114,6 +112,7 @@
 )
 from flet_core.cupertino_dialog_action import CupertinoDialogAction
 from flet_core.cupertino_filled_button import CupertinoFilledButton
+from flet_core.cupertino_icons import CupertinoIcons, cupertino_icons
 from flet_core.cupertino_list_tile import CupertinoListTile
 from flet_core.cupertino_navigation_bar import CupertinoNavigationBar
 from flet_core.cupertino_picker import CupertinoPicker
@@ -202,6 +201,7 @@
 from flet_core.haptic_feedback import HapticFeedback
 from flet_core.icon import Icon
 from flet_core.icon_button import IconButton
+from flet_core.icons import Icons, icons
 from flet_core.image import Image
 from flet_core.interactive_viewer import (
     InteractiveViewer,

sdk/python/packages/flet-core/src/flet_core/alert_dialog.py

@@ -8,9 +8,11 @@
 from flet_core.text_style import TextStyle
 from flet_core.types import (
     ClipBehavior,
+    ColorEnums,
+    ColorValue,
     MainAxisAlignment,
-    PaddingValue,
     OptionalControlEventCallable,
+    PaddingValue,
 )
 
 
@@ -69,7 +71,7 @@ def __init__(
         title: Optional[Control] = None,
         content: Optional[Control] = None,
         actions: Optional[List[Control]] = None,
-        bgcolor: Optional[str] = None,
+        bgcolor: Optional[ColorValue] = None,
         elevation: OptionalNumber = None,
         icon: Optional[Control] = None,
         open: bool = False,
@@ -81,9 +83,9 @@ def __init__(
         inset_padding: PaddingValue = None,
         icon_padding: PaddingValue = None,
         action_button_padding: PaddingValue = None,
-        surface_tint_color: Optional[str] = None,
-        shadow_color: Optional[str] = None,
-        icon_color: Optional[str] = None,
+        surface_tint_color: Optional[ColorValue] = None,
+        shadow_color: Optional[ColorValue] = None,
+        icon_color: Optional[ColorValue] = None,
         scrollable: Optional[bool] = None,
         actions_overflow_button_spacing: OptionalNumber = None,
         alignment: Optional[Alignment] = None,
@@ -187,39 +189,43 @@ def open(self, value: Optional[bool]):
 
     # bgcolor
     @property
-    def bgcolor(self) -> Optional[str]:
-        return self._get_attr("bgcolor")
+    def bgcolor(self) -> Optional[ColorValue]:
+        return self.__bgcolor
 
     @bgcolor.setter
-    def bgcolor(self, value: Optional[str]):
-        self._set_attr("bgcolor", value)
+    def bgcolor(self, value: Optional[ColorValue]):
+        self.__bgcolor = value
+        self._set_enum_attr("bgcolor", value, ColorEnums)
 
     # shadow_color
     @property
-    def shadow_color(self) -> Optional[str]:
-        return self._get_attr("shadowColor")
+    def shadow_color(self) -> Optional[ColorValue]:
+        return self.__shadow_color
 
     @shadow_color.setter
-    def shadow_color(self, value: Optional[str]):
-        self._set_attr("shadowColor", value)
+    def shadow_color(self, value: Optional[ColorValue]):
+        self.__shadow_color = value
+        self._set_enum_attr("shadowColor", value, ColorEnums)
 
     # surface_tint_color
     @property
-    def surface_tint_color(self) -> Optional[str]:
-        return self._get_attr("surfaceTintColor")
+    def surface_tint_color(self) -> Optional[ColorValue]:
+        return self.__surface_tint_color
 
     @surface_tint_color.setter
-    def surface_tint_color(self, value: Optional[str]):
-        self._set_attr("surfaceTintColor", value)
+    def surface_tint_color(self, value: Optional[ColorValue]):
+        self.__surface_tint_color = value
+        self._set_enum_attr("surfaceTintColor", value, ColorEnums)
 
     # icon_color
     @property
-    def icon_color(self) -> Optional[str]:
-        return self._get_attr("iconColor")
+    def icon_color(self) -> Optional[ColorValue]:
+        return self.__icon_color
 
     @icon_color.setter
-    def icon_color(self, value: Optional[str]):
-        self._set_attr("iconColor", value)
+    def icon_color(self, value: Optional[ColorValue]):
+        self.__icon_color = value
+        self._set_enum_attr("iconColor", value, ColorEnums)
 
     # elevation
     @property

sdk/python/packages/flet-core/src/flet_core/app_bar.py

@@ -1,11 +1,11 @@
-from typing import List, Optional, Any
+from typing import Any, List, Optional
 
 from flet_core.adaptive_control import AdaptiveControl
 from flet_core.buttons import OutlinedBorder
 from flet_core.control import Control
 from flet_core.ref import Ref
 from flet_core.text_style import TextStyle
-from flet_core.types import ClipBehavior, OptionalNumber
+from flet_core.types import ClipBehavior, ColorEnums, ColorValue, OptionalNumber
 
 
 class AppBar(AdaptiveControl):
@@ -60,12 +60,12 @@ def __init__(
         title: Optional[Control] = None,
         center_title: Optional[bool] = None,
         toolbar_height: OptionalNumber = None,
-        color: Optional[str] = None,
-        bgcolor: Optional[str] = None,
+        color: Optional[ColorValue] = None,
+        bgcolor: Optional[ColorValue] = None,
         elevation: OptionalNumber = None,
         elevation_on_scroll: OptionalNumber = None,
-        shadow_color: Optional[str] = None,
-        surface_tint_color: Optional[str] = None,
+        shadow_color: Optional[ColorValue] = None,
+        surface_tint_color: Optional[ColorValue] = None,
         clip_behavior: Optional[ClipBehavior] = None,
         force_material_transparency: Optional[bool] = None,
         is_secondary: Optional[bool] = None,
@@ -252,39 +252,43 @@ def toolbar_height(self, value: OptionalNumber):
 
     # color
     @property
-    def color(self) -> Optional[str]:
-        return self._get_attr("color")
+    def color(self) -> Optional[ColorValue]:
+        return self.__color
 
     @color.setter
-    def color(self, value: Optional[str]):
-        self._set_attr("color", value)
+    def color(self, value: Optional[ColorValue]):
+        self.__color = value
+        self._set_enum_attr("color", value, ColorEnums)
 
     # bgcolor
     @property
-    def bgcolor(self) -> Optional[str]:
-        return self._get_attr("bgcolor")
+    def bgcolor(self) -> Optional[ColorValue]:
+        return self.__bgcolor
 
     @bgcolor.setter
-    def bgcolor(self, value: Optional[str]):
-        self._set_attr("bgcolor", value)
+    def bgcolor(self, value: Optional[ColorValue]):
+        self.__bgcolor = value
+        self._set_enum_attr("bgcolor", value, ColorEnums)
 
     # shadow_color
     @property
-    def shadow_color(self) -> Optional[str]:
-        return self._get_attr("shadowColor")
+    def shadow_color(self) -> Optional[ColorValue]:
+        return self.__shadow_color
 
     @shadow_color.setter
-    def shadow_color(self, value: Optional[str]):
-        self._set_attr("shadowColor", value)
+    def shadow_color(self, value: Optional[ColorValue]):
+        self.__shadow_color = value
+        self._set_enum_attr("shadowColor", value, ColorEnums)
 
     # surface_tint_color
     @property
-    def surface_tint_color(self) -> Optional[str]:
-        return self._get_attr("surfaceTintColor")
+    def surface_tint_color(self) -> Optional[ColorValue]:
+        return self.__surface_tint_color
 
     @surface_tint_color.setter
-    def surface_tint_color(self, value: Optional[str]):
-        self._set_attr("surfaceTintColor", value)
+    def surface_tint_color(self, value: Optional[ColorValue]):
+        self.__surface_tint_color = value
+        self._set_enum_attr("surfaceTintColor", value, ColorEnums)
 
     # is_secondary
     @property

sdk/python/packages/flet-core/src/flet_core/badge.py

@@ -3,7 +3,7 @@
 
 from flet_core.alignment import Alignment
 from flet_core.text_style import TextStyle
-from flet_core.types import OffsetValue, OptionalNumber, PaddingValue
+from flet_core.types import ColorValue, OffsetValue, OptionalNumber, PaddingValue
 
 
 @dataclass
@@ -14,12 +14,12 @@ class Badge:
     text: Optional[str] = None
     offset: OffsetValue = None
     alignment: Optional[Alignment] = None
-    bgcolor: Optional[str] = None
+    bgcolor: Optional[ColorValue] = None
     label_visible: Optional[bool] = None
     large_size: OptionalNumber = None
     padding: Optional[PaddingValue] = None
     small_size: OptionalNumber = None
-    text_color: Optional[str] = None
+    text_color: Optional[ColorValue] = None
     text_style: Optional[TextStyle] = None
 
 

sdk/python/packages/flet-core/src/flet_core/banner.py

@@ -4,9 +4,11 @@
 from flet_core.ref import Ref
 from flet_core.text_style import TextStyle
 from flet_core.types import (
-    PaddingValue,
+    ColorEnums,
+    ColorValue,
     MarginValue,
     OptionalControlEventCallable,
+    PaddingValue,
 )
 
 
@@ -63,10 +65,10 @@ def __init__(
         leading_padding: Optional[PaddingValue] = None,
         content_padding: Optional[PaddingValue] = None,
         force_actions_below: Optional[bool] = None,
-        bgcolor: Optional[str] = None,
-        surface_tint_color: Optional[str] = None,
-        shadow_color: Optional[str] = None,
-        divider_color: Optional[str] = None,
+        bgcolor: Optional[ColorValue] = None,
+        surface_tint_color: Optional[ColorValue] = None,
+        shadow_color: Optional[ColorValue] = None,
+        divider_color: Optional[ColorValue] = None,
         elevation: OptionalNumber = None,
         margin: MarginValue = None,
         content_text_style: Optional[TextStyle] = None,
@@ -213,12 +215,13 @@ def force_actions_below(self, value: Optional[bool]):
 
     # bgcolor
     @property
-    def bgcolor(self) -> Optional[str]:
-        return self._get_attr("bgColor")
+    def bgcolor(self) -> Optional[ColorValue]:
+        return self.__bgcolor
 
     @bgcolor.setter
-    def bgcolor(self, value: Optional[str]):
-        self._set_attr("bgColor", value)
+    def bgcolor(self, value: Optional[ColorValue]):
+        self.__bgcolor = value
+        self._set_enum_attr("bgColor", value, ColorEnums)
 
     # content_text_style
     @property
@@ -231,30 +234,33 @@ def content_text_style(self, value: Optional[TextStyle]):
 
     # shadow_color
     @property
-    def shadow_color(self) -> Optional[str]:
-        return self._get_attr("shadowColor")
+    def shadow_color(self) -> Optional[ColorValue]:
+        return self.__shadow_color
 
     @shadow_color.setter
-    def shadow_color(self, value: Optional[str]):
-        self._set_attr("shadowColor", value)
+    def shadow_color(self, value: Optional[ColorValue]):
+        self.__shadow_color = value
+        self._set_enum_attr("shadowColor", value, ColorEnums)
 
     # surface_tint_color
     @property
-    def surface_tint_color(self) -> Optional[str]:
-        return self._get_attr("surfaceTintColor")
+    def surface_tint_color(self) -> Optional[ColorValue]:
+        return self.__surface_tint_color
 
     @surface_tint_color.setter
-    def surface_tint_color(self, value: Optional[str]):
-        self._set_attr("surfaceTintColor", value)
+    def surface_tint_color(self, value: Optional[ColorValue]):
+        self.__surface_tint_color = value
+        self._set_enum_attr("surfaceTintColor", value, ColorEnums)
 
     # divider_color
     @property
-    def divider_color(self) -> Optional[str]:
-        return self._get_attr("dividerColor")
+    def divider_color(self) -> Optional[ColorValue]:
+        return self.__divider_color
 
     @divider_color.setter
-    def divider_color(self, value: Optional[str]):
-        self._set_attr("dividerColor", value)
+    def divider_color(self, value: Optional[ColorValue]):
+        self.__divider_color = value
+        self._set_enum_attr("dividerColor", value, ColorEnums)
 
     # elevation
     @property

sdk/python/packages/flet-core/src/flet_core/border.py

@@ -2,7 +2,7 @@
 from enum import Enum
 from typing import Optional, Union
 
-from flet_core.types import OptionalNumber
+from flet_core.types import ColorValue, OptionalNumber
 
 
 class BorderSideStrokeAlign(Enum):
@@ -14,7 +14,7 @@ class BorderSideStrokeAlign(Enum):
 @dataclass
 class BorderSide:
     width: OptionalNumber
-    color: Optional[str] = field(default=None)
+    color: Optional[ColorValue] = field(default=None)
     stroke_align: Union[BorderSideStrokeAlign, OptionalNumber] = field(default=None)
 
 
@@ -26,7 +26,7 @@ class Border:
     left: Optional[BorderSide] = field(default=None)
 
 
-def all(width: Optional[float] = None, color: Optional[str] = None) -> Border:
+def all(width: Optional[float] = None, color: Optional[ColorValue] = None) -> Border:
     bs = BorderSide(width, color)
     return Border(left=bs, top=bs, right=bs, bottom=bs)