refactor!: rename context menu children into items

BREAKING CHANGE: Rename `children` parameter of `ShadContextMenu` and `ShadContextMenuRegion` into `items`.
nank1ro · Oct 2, 2024 · 49a69d8 · 49a69d8
1 parent 3f72455
commit 49a69d8
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.10.0
+
+- __BREAKING CHANGE__: Rename `children` parameter of `ShadContextMenu` and `ShadContextMenuRegion` into `items`.
+
 ## 0.9.8
 
 - Improve the `ShadContextMenu` right click behavior on Web.

diff --git a/docs/src/content/docs/Components/context-menu.mdx b/docs/src/content/docs/Components/context-menu.mdx
@@ -3,7 +3,8 @@ title: Context Menu
 sidebar:
   order: 4
 ---
-import Preview from '../../../components/Preview.astro';
+
+import Preview from "../../../components/Preview.astro";
 
 Displays a menu to the user — such as a set of actions or functions — triggered by a mouse right-click.
 
@@ -34,7 +35,7 @@ class ContextMenuPage extends StatelessWidget {
             ),
             child: const Text('Right click here'),
           ),
-          children: [
+          items: [
             const ShadContextMenuItem.inset(
               child: Text('Back'),
             ),
@@ -51,7 +52,7 @@ class ContextMenuPage extends StatelessWidget {
                 LucideIcons.chevronRight,
                 size: 16,
               ),
-              children: [
+              items: [
                 ShadContextMenuItem(
                   child: Text('Save Page As...'),
                 ),
@@ -105,4 +106,3 @@ class ContextMenuPage extends StatelessWidget {
 ```
 
 </Preview>
-
diff --git a/lib/src/components/context_menu.dart b/lib/src/components/context_menu.dart
@@ -388,18 +388,18 @@ class ShadContextMenuItemController extends ChangeNotifier {
 
   final Key itemKey;
 
-  /// Maps the children key to the item controller
-  final Map<Key, ShadContextMenuItemController> children = {};
+  /// Maps the item key to the item controller
+  final Map<Key, ShadContextMenuItemController> items = {};
 
   bool get selected =>
-      _hovered || _focused || children.values.any((e) => e.selected);
+      _hovered || _focused || items.values.any((e) => e.selected);
 
   void registerSubItem(ShadContextMenuItemController controller) {
-    children[controller.itemKey] = controller;
+    items[controller.itemKey] = controller;
   }
 
   void unregisterSubItem(ShadContextMenuItemController controller) {
-    children.remove(controller.itemKey);
+    items.remove(controller.itemKey);
   }
 }
 
@@ -784,7 +784,7 @@ class _ShadContextMenuItemState extends State<ShadContextMenuItem> {
       ),
     );
 
-    // if the item has at least one submenu item, wrap it in a provider to 
+    // if the item has at least one submenu item, wrap it in a provider to
     //provide the controller to the submenu items
     if (widget.items.isNotEmpty) {
       child = ShadProvider(

diff --git a/playground/lib/pages/context_menu.dart b/playground/lib/pages/context_menu.dart
@@ -12,16 +12,6 @@ class ContextMenuPage extends StatelessWidget {
         padding: const EdgeInsets.all(16),
         child: ShadContextMenuRegion(
           constraints: const BoxConstraints(minWidth: 300),
-          child: Container(
-            width: 300,
-            height: 200,
-            alignment: Alignment.center,
-            decoration: BoxDecoration(
-              border: Border.all(color: theme.colorScheme.border),
-              borderRadius: BorderRadius.circular(8),
-            ),
-            child: const Text('Right click here'),
-          ),
           items: [
             const ShadContextMenuItem.inset(
               child: Text('Back'),
@@ -34,7 +24,6 @@ class ContextMenuPage extends StatelessWidget {
               child: Text('Reload'),
             ),
             const ShadContextMenuItem.inset(
-              child: Text('More Tools'),
               trailing: ShadImage.square(
                 LucideIcons.chevronRight,
                 size: 16,
@@ -54,6 +43,7 @@ class ContextMenuPage extends StatelessWidget {
                   child: Text('Developer Tools'),
                 ),
               ],
+              child: Text('More Tools'),
             ),
             const Divider(height: 8),
             const ShadContextMenuItem(
@@ -85,6 +75,16 @@ class ContextMenuPage extends StatelessWidget {
             ),
             const ShadContextMenuItem.inset(child: Text('Colm Tuite')),
           ],
+          child: Container(
+            width: 300,
+            height: 200,
+            alignment: Alignment.center,
+            decoration: BoxDecoration(
+              border: Border.all(color: theme.colorScheme.border),
+              borderRadius: BorderRadius.circular(8),
+            ),
+            child: const Text('Right click here'),
+          ),
         ),
       ),
     );

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: shadcn_ui
 description: shadcn-ui ported in Flutter. Awesome UI components for Flutter, fully customizable.
-version: 0.9.8
+version: 0.10.0
 homepage: https://mariuti.com/shadcn-ui
 repository: https://github.com/nank1ro/flutter-shadcn-ui
 documentation: https://mariuti.com/shadcn-ui