-
-
Notifications
You must be signed in to change notification settings - Fork 80
Expand file tree
/
Copy pathNavigationView.cs
More file actions
5965 lines (5243 loc) · 245 KB
/
NavigationView.cs
File metadata and controls
5965 lines (5243 loc) · 245 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See LICENSE in the project root for license information.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.Diagnostics;
using System.Windows;
using System.Windows.Automation;
using System.Windows.Automation.Peers;
using System.Windows.Controls;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shell;
using System.Windows.Threading;
using iNKORE.UI.WPF.Helpers;
using iNKORE.UI.WPF.Modern.Automation.Peers;
using iNKORE.UI.WPF.Modern.Common;
using iNKORE.UI.WPF.Modern.Common.IconKeys;
using iNKORE.UI.WPF.Modern.Controls.Primitives;
using iNKORE.UI.WPF.Modern.Helpers;
using iNKORE.UI.WPF.Modern.Input;
using iNKORE.UI.WPF.Modern.Media.Animation;
using static CppWinRTHelpers;
using static iNKORE.UI.WPF.Modern.Common.ResourceAccessor;
namespace iNKORE.UI.WPF.Modern.Controls
{
enum TopNavigationViewLayoutState
{
Uninitialized = 0,
Initialized
}
enum NavigationRecommendedTransitionDirection
{
FromOverflow, // mapping to SlideNavigationTransitionInfo FromLeft
FromLeft, // SlideNavigationTransitionInfo
FromRight, // SlideNavigationTransitionInfo
Default // Currently it's mapping to EntranceNavigationTransitionInfo and is subject to change.
}
public partial class NavigationView : ContentControl, IControlProtected
{
// General items
const string c_togglePaneButtonName = "TogglePaneButton";
const string c_paneTitleHolderFrameworkElement = "PaneTitleHolder";
const string c_paneTitleFrameworkElement = "PaneTitleTextBlock";
const string c_rootSplitViewName = "RootSplitView";
const string c_menuItemsHost = "MenuItemsHost";
const string c_footerMenuItemsHost = "FooterMenuItemsHost";
const string c_selectionIndicatorName = "SelectionIndicator";
const string c_paneContentGridName = "PaneContentGrid";
const string c_rootGridName = "RootGrid";
const string c_contentGridName = "ContentGrid";
const string c_searchButtonName = "PaneAutoSuggestButton";
const string c_paneToggleButtonIconGridColumnName = "PaneToggleButtonIconWidthColumn";
const string c_togglePaneTopPadding = "TogglePaneTopPadding";
const string c_contentPaneTopPadding = "ContentPaneTopPadding";
const string c_contentLeftPadding = "ContentLeftPadding";
const string c_navViewBackButton = "NavigationViewBackButton";
const string c_navViewBackButtonToolTip = "NavigationViewBackButtonToolTip";
const string c_navViewCloseButton = "NavigationViewCloseButton";
const string c_navViewCloseButtonToolTip = "NavigationViewCloseButtonToolTip";
const string c_paneShadowReceiverCanvas = "PaneShadowReceiver";
const string c_flyoutRootGrid = "FlyoutRootGrid";
// DisplayMode Top specific items
const string c_topNavMenuItemsHost = "TopNavMenuItemsHost";
const string c_topNavFooterMenuItemsHost = "TopFooterMenuItemsHost";
const string c_topNavOverflowButton = "TopNavOverflowButton";
const string c_topNavMenuItemsOverflowHost = "TopNavMenuItemsOverflowHost";
const string c_topNavGrid = "TopNavGrid";
const string c_topNavContentOverlayAreaGrid = "TopNavContentOverlayAreaGrid";
const string c_leftNavPaneAutoSuggestBoxPresenter = "PaneAutoSuggestBoxPresenter";
const string c_topNavPaneAutoSuggestBoxPresenter = "TopPaneAutoSuggestBoxPresenter";
const string c_paneTitlePresenter = "PaneTitlePresenter";
// DisplayMode Left specific items
const string c_leftNavFooterContentBorder = "FooterContentBorder";
const string c_leftNavPaneHeaderContentBorder = "PaneHeaderContentBorder";
const string c_leftNavPaneCustomContentBorder = "PaneCustomContentBorder";
const string c_itemsContainer = "ItemsContainerGrid";
const string c_itemsContainerRow = "ItemsContainerRow";
const string c_visualItemsSeparator = "VisualItemsSeparator";
const string c_menuItemsScrollViewer = "MenuItemsScrollViewer";
const string c_footerItemsScrollViewer = "FooterItemsScrollViewer";
const string c_paneHeaderOnTopPane = "PaneHeaderOnTopPane";
const string c_paneTitleOnTopPane = "PaneTitleOnTopPane";
const string c_paneCustomContentOnTopPane = "PaneCustomContentOnTopPane";
const string c_paneFooterOnTopPane = "PaneFooterOnTopPane";
const string c_paneHeaderCloseButtonColumn = "PaneHeaderCloseButtonColumn";
const string c_paneHeaderToggleButtonColumn = "PaneHeaderToggleButtonColumn";
const string c_paneHeaderContentBorderRow = "PaneHeaderContentBorderRow";
const int c_backButtonHeight = 40;
const int c_backButtonWidth = 40;
const int c_paneToggleButtonHeight = 40;
const int c_paneToggleButtonWidth = 40;
const int c_toggleButtonHeightWhenShouldPreserveNavigationViewRS3Behavior = 56;
const int c_backButtonRowDefinition = 1;
const float c_paneElevationTranslationZ = 32;
const int c_mainMenuBlockIndex = 0;
const int c_footerMenuBlockIndex = 1;
const int s_itemNotFound = -1;
static readonly Size c_infSize = new Size(double.PositiveInfinity, double.PositiveInfinity);
internal static readonly ControlStrings ResourceAccessor = new ControlStrings(typeof(NavigationView), ModernControlCategory.Windows);
/*
~NavigationView()
{
UnhookEventsAndClearFields(true);
}
*/
protected override AutomationPeer OnCreateAutomationPeer()
{
return new NavigationViewAutomationPeer(this);
}
void UnhookEventsAndClearFields(bool isFromDestructor = false)
{
if (m_coreTitleBar != null)
{
m_coreTitleBar.LayoutMetricsChanged -= OnTitleBarMetricsChanged;
m_coreTitleBar.IsVisibleChanged -= OnTitleBarIsVisibleChanged;
}
if (m_paneToggleButton != null)
{
m_paneToggleButton.Click -= OnPaneToggleButtonClick;
}
m_settingsItem = null;
if (m_paneSearchButton != null)
{
m_paneSearchButton.Click -= OnPaneSearchButtonClick;
m_paneSearchButton = null;
}
m_paneHeaderOnTopPane = null;
m_paneTitleOnTopPane = null;
m_itemsContainerSizeChangedRevoker?.Revoke();
if (m_paneTitleHolderFrameworkElement != null)
{
m_paneTitleHolderFrameworkElement.SizeChanged -= OnPaneTitleHolderSizeChanged;
m_paneTitleHolderFrameworkElement = null;
}
m_paneTitleFrameworkElement = null;
m_paneTitlePresenter = null;
m_paneHeaderCloseButtonColumn = null;
m_paneHeaderToggleButtonColumn = null;
m_paneHeaderContentBorderRow = null;
if (m_leftNavRepeater != null)
{
m_leftNavRepeater.ElementPrepared -= OnRepeaterElementPrepared;
m_leftNavRepeater.ElementClearing -= OnRepeaterElementClearing;
m_leftNavRepeater.IsVisibleChanged -= OnRepeaterIsVisibleChanged;
m_leftNavRepeaterGettingFocusHelper?.Dispose();
m_leftNavRepeater = null;
}
if (m_topNavRepeater != null)
{
m_topNavRepeater.ElementPrepared -= OnRepeaterElementPrepared;
m_topNavRepeater.ElementClearing -= OnRepeaterElementClearing;
m_topNavRepeater.IsVisibleChanged -= OnRepeaterIsVisibleChanged;
m_topNavRepeaterGettingFocusHelper?.Dispose();
m_topNavRepeater = null;
}
if (m_leftNavFooterMenuRepeater != null)
{
m_leftNavFooterMenuRepeater.ElementPrepared -= OnRepeaterElementPrepared;
m_leftNavFooterMenuRepeater.ElementClearing -= OnRepeaterElementClearing;
m_leftNavFooterMenuRepeater.IsVisibleChanged -= OnRepeaterIsVisibleChanged;
m_leftNavFooterMenuRepeaterGettingFocusHelper?.Dispose();
m_leftNavFooterMenuRepeater = null;
}
if (m_topNavFooterMenuRepeater != null)
{
m_topNavFooterMenuRepeater.ElementPrepared -= OnRepeaterElementPrepared;
m_topNavFooterMenuRepeater.ElementClearing -= OnRepeaterElementClearing;
m_topNavFooterMenuRepeater.IsVisibleChanged -= OnRepeaterIsVisibleChanged;
m_topNavFooterMenuRepeaterGettingFocusHelper?.Dispose();
m_topNavFooterMenuRepeater = null;
}
m_footerItemsCollectionChangedRevoker?.Revoke();
m_menuItemsCollectionChangedRevoker?.Revoke();
if (m_topNavRepeaterOverflowView != null)
{
m_topNavRepeaterOverflowView.ElementPrepared -= OnRepeaterElementPrepared;
m_topNavRepeaterOverflowView.ElementClearing -= OnRepeaterElementClearing;
m_topNavRepeaterOverflowView = null;
}
m_topNavOverflowItemsCollectionChangedRevoker?.Revoke();
if (isFromDestructor)
{
m_selectionModel.SelectionChanged -= OnSelectionModelSelectionChanged;
}
}
static NavigationView()
{
DefaultStyleKeyProperty.OverrideMetadata(typeof(NavigationView), new FrameworkPropertyMetadata(typeof(NavigationView)));
}
public NavigationView()
{
SetValue(TemplateSettingsPropertyKey, new NavigationViewTemplateSettings());
SizeChanged += OnSizeChanged;
m_selectionModelSource = new List<object>(2);
m_selectionModelSource.Add(null);
m_selectionModelSource.Add(null);
var items = new ObservableCollection<object>();
SetValue(MenuItemsProperty, items);
var footerItems = new ObservableCollection<object>();
SetValue(FooterMenuItemsProperty, footerItems);
var weakThis = new WeakReference<NavigationView>(this);
m_topDataProvider.OnRawDataChanged(
args =>
{
if (weakThis.TryGetTarget(out var target))
{
target.OnTopNavDataSourceChanged(args);
}
});
Unloaded += OnUnloaded;
Loaded += OnLoaded;
m_selectionModel.SingleSelect = true;
m_selectionModel.Source = m_selectionModelSource;
m_selectionModel.SelectionChanged += OnSelectionModelSelectionChanged;
m_selectionModel.ChildrenRequested += OnSelectionModelChildrenRequested;
m_navigationViewItemsFactory = new NavigationViewItemsFactory();
if (ShadowAssist.UseBitmapCache)
{
m_bitmapCache = new BitmapCache();
#if NET462_OR_NEWER
m_bitmapCache.RenderAtScale = VisualTreeHelper.GetDpi(this).PixelsPerDip;
#endif
}
}
void OnSelectionModelChildrenRequested(SelectionModel selectionModel, SelectionModelChildrenRequestedEventArgs e)
{
// this is main menu or footer
if (e.SourceIndex.GetSize() == 1)
{
e.Children = e.Source;
}
else if (e.Source is NavigationViewItem nvi)
{
e.Children = GetChildren(nvi);
}
else if (GetChildrenForItemInIndexPath(e.SourceIndex, true /*forceRealize*/) is { } children)
{
e.Children = children;
}
}
void OnFooterItemsSourceCollectionChanged(object sender, object e)
{
UpdateFooterRepeaterItemsSource(false /*sourceCollectionReset*/, true /*sourceCollectionChanged*/);
// Pane footer items changed. This means we might need to reevaluate the pane layout.
UpdatePaneLayout();
}
void OnOverflowItemsSourceCollectionChanged(object sender, object e)
{
if (m_topNavRepeaterOverflowView.ItemsSourceView.Count == 0)
{
SetOverflowButtonVisibility(Visibility.Collapsed);
}
}
void OnSelectionModelSelectionChanged(SelectionModel selectionModel, SelectionModelSelectionChangedEventArgs e)
{
var selectedItem = selectionModel.SelectedItem;
// Ignore this callback if:
// 1. the SelectedItem property of NavigationView is already set to the item
// being passed in this callback. This is because the item has already been selected
// via API and we are just updating the m_selectionModel state to accurately reflect the new selection.
// 2. Template has not been applied yet. SelectionModel's selectedIndex state will get properly updated
// after the repeater finishes loading.
// TODO: Update SelectedItem comparison to work for the exact same item datasource scenario
if (m_shouldIgnoreNextSelectionChange || selectedItem == SelectedItem || !m_appliedTemplate)
{
return;
}
bool setSelectedItem = true;
var selectedIndex = selectionModel.SelectedIndex;
if (IsTopNavigationView())
{
// If selectedIndex does not exist, means item is being deselected through API
var isInOverflow = (selectedIndex != null && selectedIndex.GetSize() > 1)
? selectedIndex.GetAt(0) == c_mainMenuBlockIndex && !m_topDataProvider.IsItemInPrimaryList(selectedIndex.GetAt(1))
: false;
if (isInOverflow)
{
// We only want to close the overflow flyout and move the item on selection if it is a leaf node
bool itemShouldBeMoved;
{
bool init()
{
if (GetContainerForIndexPath(selectedIndex) is { } selectedContainer)
{
if (selectedContainer is NavigationViewItem selectedNVI)
{
if (DoesNavigationViewItemHaveChildren(selectedNVI))
{
return false;
}
}
}
return true;
}
itemShouldBeMoved = init();
}
if (itemShouldBeMoved)
{
SelectandMoveOverflowItem(selectedItem, selectedIndex, true /*closeFlyout*/);
setSelectedItem = false;
}
else
{
m_moveTopNavOverflowItemOnFlyoutClose = true;
}
}
}
if (setSelectedItem)
{
SetSelectedItemAndExpectItemInvokeWhenSelectionChangedIfNotInvokedFromAPI(selectedItem);
}
}
void SelectandMoveOverflowItem(object selectedItem, IndexPath selectedIndex, bool closeFlyout)
{
// SelectOverflowItem is moving data in/out of overflow.
try
{
m_selectionChangeFromOverflowMenu = true;
if (closeFlyout)
{
CloseTopNavigationViewFlyout();
}
if (!IsSelectionSuppressed(selectedItem))
{
SelectOverflowItem(selectedItem, selectedIndex);
}
}
finally
{
m_selectionChangeFromOverflowMenu = false;
}
}
// We only need to close the flyout if the selected item is a leaf node
void CloseFlyoutIfRequired(NavigationViewItem selectedItem)
{
var selectedIndex = m_selectionModel.SelectedIndex;
bool isInModeWithFlyout;
{
bool init()
{
if (m_rootSplitView is { } splitView)
{
// Check if the pane is closed and if the splitview is in either compact mode.
var splitViewDisplayMode = splitView.DisplayMode;
return (!splitView.IsPaneOpen && (splitViewDisplayMode == SplitViewDisplayMode.CompactOverlay || splitViewDisplayMode == SplitViewDisplayMode.CompactInline)) ||
PaneDisplayMode == NavigationViewPaneDisplayMode.Top;
}
return false;
}
isInModeWithFlyout = init();
}
if (isInModeWithFlyout && selectedIndex != null && !DoesNavigationViewItemHaveChildren(selectedItem))
{
// Item selected is a leaf node, find top level parent and close flyout
if (GetContainerForIndex(selectedIndex.GetAt(1), selectedIndex.GetAt(0) == c_footerMenuBlockIndex /* inFooter */) is { } rootItem)
{
if (rootItem is NavigationViewItem nvi)
{
var nviImpl = nvi;
if (nviImpl.ShouldRepeaterShowInFlyout())
{
nvi.IsExpanded = false;
}
}
}
}
}
public override void OnApplyTemplate()
{
base.OnApplyTemplate();
// Stop update anything because of PropertyChange during OnApplyTemplate. Update them all together at the end of this function
m_appliedTemplate = false;
UnhookEventsAndClearFields();
IControlProtected controlProtected = this;
// Set up the pane toggle button click handler
if (GetTemplateChild(c_togglePaneButtonName) is Button paneToggleButton)
{
m_paneToggleButton = paneToggleButton;
paneToggleButton.Click += OnPaneToggleButtonClick;
SetPaneToggleButtonAutomationName();
// TODO: WPF - KeyboardAccelerator
/*
if (SharedHelpers::IsRS3OrHigher())
{
winrt::KeyboardAccelerator keyboardAccelerator;
keyboardAccelerator.Key(winrt::VirtualKey::Back);
keyboardAccelerator.Modifiers(winrt::VirtualKeyModifiers::Windows);
paneToggleButton.KeyboardAccelerators().Append(keyboardAccelerator);
}
*/
WindowChrome.SetIsHitTestVisibleInChrome(paneToggleButton, true);
}
m_leftNavPaneHeaderContentBorder = GetTemplateChild(c_leftNavPaneHeaderContentBorder) as ContentControl;
m_leftNavPaneCustomContentBorder = GetTemplateChild(c_leftNavPaneCustomContentBorder) as ContentControl;
m_leftNavFooterContentBorder = GetTemplateChild(c_leftNavFooterContentBorder) as ContentControl;
m_paneHeaderOnTopPane = GetTemplateChild(c_paneHeaderOnTopPane) as ContentControl;
m_paneTitleOnTopPane = GetTemplateChild(c_paneTitleOnTopPane) as ContentControl;
m_paneCustomContentOnTopPane = GetTemplateChild(c_paneCustomContentOnTopPane) as ContentControl;
m_paneFooterOnTopPane = GetTemplateChild(c_paneFooterOnTopPane) as ContentControl;
// Get a pointer to the root SplitView
if (GetTemplateChild(c_rootSplitViewName) is SplitView splitView)
{
m_rootSplitView = splitView;
splitView.IsPaneOpenChanged += OnSplitViewClosedCompactChanged;
splitView.DisplayModeChanged += OnSplitViewClosedCompactChanged;
if (SharedHelpers.IsRS3OrHigher()) // These events are new to RS3/v5 API
{
splitView.PaneClosed += OnSplitViewPaneClosed;
splitView.PaneClosing += OnSplitViewPaneClosing;
splitView.PaneOpened += OnSplitViewPaneOpened;
splitView.PaneOpening += OnSplitViewPaneOpening;
}
UpdateIsClosedCompact();
}
m_topNavGrid = GetTemplateChild(c_topNavGrid) as Grid;
// Change code to NOT do this if we're in top nav mode, to prevent it from being realized:
if (GetTemplateChild(c_menuItemsHost) is ItemsRepeater leftNavRepeater)
{
m_leftNavRepeater = leftNavRepeater;
// API is currently in preview, so setting this via code.
// Disabling virtualization for now because of https://github.com/microsoft/microsoft-ui-xaml/issues/2095
if (leftNavRepeater.Layout is StackLayout stackLayout)
{
var stackLayoutImpl = stackLayout;
stackLayoutImpl.DisableVirtualization = true;
}
leftNavRepeater.ElementPrepared += OnRepeaterElementPrepared;
leftNavRepeater.ElementClearing += OnRepeaterElementClearing;
leftNavRepeater.IsVisibleChanged += OnRepeaterIsVisibleChanged;
m_leftNavRepeaterGettingFocusHelper = new GettingFocusHelper(leftNavRepeater);
m_leftNavRepeaterGettingFocusHelper.GettingFocus += OnRepeaterGettingFocus;
leftNavRepeater.ItemTemplate = m_navigationViewItemsFactory;
}
// Change code to NOT do this if we're in left nav mode, to prevent it from being realized:
if (GetTemplateChild(c_topNavMenuItemsHost) is ItemsRepeater topNavRepeater)
{
m_topNavRepeater = topNavRepeater;
// API is currently in preview, so setting this via code
if (topNavRepeater.Layout is StackLayout stackLayout)
{
var stackLayoutImpl = stackLayout;
stackLayoutImpl.DisableVirtualization = true;
}
topNavRepeater.ElementPrepared += OnRepeaterElementPrepared;
topNavRepeater.ElementClearing += OnRepeaterElementClearing;
topNavRepeater.IsVisibleChanged += OnRepeaterIsVisibleChanged;
m_topNavRepeaterGettingFocusHelper = new GettingFocusHelper(topNavRepeater);
m_topNavRepeaterGettingFocusHelper.GettingFocus += OnRepeaterGettingFocus;
topNavRepeater.ItemTemplate = m_navigationViewItemsFactory;
}
// Change code to NOT do this if we're in left nav mode, to prevent it from being realized:
if (GetTemplateChild(c_topNavMenuItemsOverflowHost) is ItemsRepeater topNavListOverflowRepeater)
{
m_topNavRepeaterOverflowView = topNavListOverflowRepeater;
// API is currently in preview, so setting this via code.
// Disabling virtualization for now because of https://github.com/microsoft/microsoft-ui-xaml/issues/2095
if (topNavListOverflowRepeater.Layout is StackLayout stackLayout)
{
var stackLayoutImpl = stackLayout;
stackLayoutImpl.DisableVirtualization = true;
}
topNavListOverflowRepeater.ElementPrepared += OnRepeaterElementPrepared;
topNavListOverflowRepeater.ElementClearing += OnRepeaterElementClearing;
topNavListOverflowRepeater.ItemTemplate = m_navigationViewItemsFactory;
}
if (GetTemplateChild(c_topNavOverflowButton) is Button topNavOverflowButton)
{
m_topNavOverflowButton = topNavOverflowButton;
AutomationProperties.SetName(topNavOverflowButton, ResourceAccessor.GetLocalizedStringResource(SR_NavigationOverflowButtonName));
topNavOverflowButton.Content = ResourceAccessor.GetLocalizedStringResource(SR_NavigationOverflowButtonText);
// TODO: WPF - Header Animation
/*
auto visual = winrt::ElementCompositionPreview::GetElementVisual(topNavOverflowButton);
CreateAndAttachHeaderAnimation(visual);
*/
var toolTip = ToolTipService.GetToolTip(topNavOverflowButton);
if (toolTip is null)
{
var tooltip = new ToolTip();
tooltip.Content = ResourceAccessor.GetLocalizedStringResource(SR_NavigationOverflowButtonToolTip);
ToolTipService.SetToolTip(topNavOverflowButton, tooltip);
}
if (FlyoutService.GetFlyout(topNavOverflowButton) is { } flyoutBase)
{
/*
if (winrt::IFlyoutBase6 topNavOverflowButtonAsFlyoutBase6 = flyoutBase)
{
topNavOverflowButtonAsFlyoutBase6.ShouldConstrainToRootBounds(false);
}
*/
flyoutBase.Closing += OnFlyoutClosing;
flyoutBase.Offset = 0;
}
}
// Change code to NOT do this if we're in top nav mode, to prevent it from being realized:
if (GetTemplateChildT<ItemsRepeater>(c_footerMenuItemsHost, controlProtected) is { } leftFooterMenuNavRepeater)
{
m_leftNavFooterMenuRepeater = leftFooterMenuNavRepeater;
// API is currently in preview, so setting this via code.
// Disabling virtualization for now because of https://github.com/microsoft/microsoft-ui-xaml/issues/2095
if (leftFooterMenuNavRepeater.Layout is StackLayout stackLayout)
{
var stackLayoutImpl = stackLayout;
stackLayoutImpl.DisableVirtualization = true;
}
leftFooterMenuNavRepeater.ElementPrepared += OnRepeaterElementPrepared;
leftFooterMenuNavRepeater.ElementClearing += OnRepeaterElementClearing;
leftFooterMenuNavRepeater.IsVisibleChanged += OnRepeaterIsVisibleChanged;
m_leftNavFooterMenuRepeaterGettingFocusHelper = new GettingFocusHelper(leftFooterMenuNavRepeater);
m_leftNavFooterMenuRepeaterGettingFocusHelper.GettingFocus += OnRepeaterGettingFocus;
leftFooterMenuNavRepeater.ItemTemplate = m_navigationViewItemsFactory;
}
// Change code to NOT do this if we're in left nav mode, to prevent it from being realized:
if (GetTemplateChildT<ItemsRepeater>(c_topNavFooterMenuItemsHost, controlProtected) is { } topFooterMenuNavRepeater)
{
m_topNavFooterMenuRepeater = topFooterMenuNavRepeater;
// API is currently in preview, so setting this via code.
// Disabling virtualization for now because of https://github.com/microsoft/microsoft-ui-xaml/issues/2095
if (topFooterMenuNavRepeater.Layout is StackLayout stackLayout)
{
var stackLayoutImpl = stackLayout;
stackLayoutImpl.DisableVirtualization = true;
}
topFooterMenuNavRepeater.ElementPrepared += OnRepeaterElementPrepared;
topFooterMenuNavRepeater.ElementClearing += OnRepeaterElementClearing;
topFooterMenuNavRepeater.IsVisibleChanged += OnRepeaterIsVisibleChanged;
m_topNavFooterMenuRepeaterGettingFocusHelper = new GettingFocusHelper(topFooterMenuNavRepeater);
m_topNavFooterMenuRepeaterGettingFocusHelper.GettingFocus += OnRepeaterGettingFocus;
topFooterMenuNavRepeater.ItemTemplate = m_navigationViewItemsFactory;
}
m_topNavContentOverlayAreaGrid = GetTemplateChild(c_topNavContentOverlayAreaGrid) as Border;
m_leftNavPaneAutoSuggestBoxPresenter = GetTemplateChild(c_leftNavPaneAutoSuggestBoxPresenter) as ContentControl;
m_topNavPaneAutoSuggestBoxPresenter = GetTemplateChild(c_topNavPaneAutoSuggestBoxPresenter) as ContentControl;
// Get pointer to the pane content area, for use in the selection indicator animation
m_paneContentGrid = GetTemplateChild(c_paneContentGridName) as UIElement;
m_contentLeftPadding = GetTemplateChild(c_contentLeftPadding) as FrameworkElement;
m_paneHeaderCloseButtonColumn = GetTemplateChild(c_paneHeaderCloseButtonColumn) as ColumnDefinition;
m_paneHeaderToggleButtonColumn = GetTemplateChild(c_paneHeaderToggleButtonColumn) as ColumnDefinition;
m_paneHeaderContentBorderRow = GetTemplateChild(c_paneHeaderContentBorderRow) as RowDefinition;
m_paneTitleFrameworkElement = GetTemplateChild(c_paneTitleFrameworkElement) as FrameworkElement;
m_paneTitlePresenter = GetTemplateChild(c_paneTitlePresenter) as ContentControl;
if (GetTemplateChild(c_paneTitleHolderFrameworkElement) is FrameworkElement paneTitleHolderFrameworkElement)
{
m_paneTitleHolderFrameworkElement = paneTitleHolderFrameworkElement;
paneTitleHolderFrameworkElement.SizeChanged += OnPaneTitleHolderSizeChanged;
}
// Set automation name on search button
if (GetTemplateChild(c_searchButtonName) is Button button)
{
m_paneSearchButton = button;
button.Click += OnPaneSearchButtonClick;
var searchButtonName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationViewSearchButtonName);
AutomationProperties.SetName(button, searchButtonName);
var toolTip = new ToolTip();
toolTip.Content = searchButtonName;
ToolTipService.SetToolTip(button, toolTip);
}
if (GetTemplateChild(c_navViewBackButton) is Button backButton)
{
m_backButton = backButton;
backButton.Click += OnBackButtonClicked;
string navigationName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationBackButtonName);
AutomationProperties.SetName(backButton, navigationName);
WindowChrome.SetIsHitTestVisibleInChrome(backButton, true);
}
// Register for changes in title bar layout
if (CoreApplicationViewTitleBar.GetTitleBar(this) is { } coreTitleBar)
{
m_coreTitleBar = coreTitleBar;
coreTitleBar.LayoutMetricsChanged += OnTitleBarMetricsChanged;
coreTitleBar.IsVisibleChanged += OnTitleBarIsVisibleChanged;
if (ShouldPreserveNavigationViewRS4Behavior())
{
m_togglePaneTopPadding = GetTemplateChild(c_togglePaneTopPadding) as FrameworkElement;
m_contentPaneTopPadding = GetTemplateChild(c_contentPaneTopPadding) as FrameworkElement;
}
}
if (GetTemplateChild(c_navViewBackButtonToolTip) is ToolTip backButtonToolTip)
{
string navigationBackButtonToolTip = ResourceAccessor.GetLocalizedStringResource(SR_NavigationBackButtonToolTip);
backButtonToolTip.Content = navigationBackButtonToolTip;
}
if (GetTemplateChild(c_navViewCloseButton) is Button closeButton)
{
m_closeButton = closeButton;
closeButton.Click += OnPaneToggleButtonClick;
string navigationName = ResourceAccessor.GetLocalizedStringResource(SR_NavigationCloseButtonName);
AutomationProperties.SetName(closeButton, navigationName);
WindowChrome.SetIsHitTestVisibleInChrome(closeButton, true);
}
if (GetTemplateChild(c_navViewCloseButtonToolTip) is ToolTip closeButtonToolTip)
{
string navigationCloseButtonToolTip = ResourceAccessor.GetLocalizedStringResource(SR_NavigationButtonOpenName);
closeButtonToolTip.Content = navigationCloseButtonToolTip;
}
m_itemsContainerRow = GetTemplateChildT<RowDefinition>(c_itemsContainerRow, controlProtected);
m_menuItemsScrollViewer = GetTemplateChildT<FrameworkElement>(c_menuItemsScrollViewer, controlProtected);
m_footerItemsScrollViewer = GetTemplateChildT<FrameworkElement>(c_footerItemsScrollViewer, controlProtected);
m_visualItemsSeparator = GetTemplateChildT<FrameworkElement>(c_visualItemsSeparator, controlProtected);
m_itemsContainerSizeChangedRevoker?.Revoke();
if (GetTemplateChildT<FrameworkElement>(c_itemsContainer, controlProtected) is { } itemsContainerRow)
{
m_itemsContainerSizeChangedRevoker = new FrameworkElementSizeChangedRevoker(itemsContainerRow, OnItemsContainerSizeChanged);
}
if (SharedHelpers.IsRS2OrHigher())
{
// Get hold of the outermost grid and enable XYKeyboardNavigationMode
// However, we only want this to work in the content pane + the hamburger button (which is not inside the splitview)
// so disable it on the grid in the content area of the SplitView
if (GetTemplateChildT<Grid>(c_rootGridName, controlProtected) is { } rootGrid)
{
KeyboardNavigation.SetDirectionalNavigation(rootGrid, KeyboardNavigationMode.Contained);
}
if (GetTemplateChildT<Grid>(c_contentGridName, controlProtected) is { } contentGrid)
{
KeyboardNavigation.SetDirectionalNavigation(contentGrid, KeyboardNavigationMode.None);
}
}
// TODO: WPF - AccessKey
//m_accessKeyInvokedRevoker = AccessKeyInvoked(winrt::auto_revoke, { this, &NavigationView::OnAccessKeyInvoked });
UpdatePaneShadow();
m_appliedTemplate = true;
// Do initial setup
UpdatePaneDisplayMode();
UpdateHeaderVisibility();
UpdatePaneTitleFrameworkElementParents();
UpdateTitleBarPadding();
UpdatePaneTabFocusNavigation();
UpdateBackAndCloseButtonsVisibility();
UpdateSingleSelectionFollowsFocusTemplateSetting();
UpdatePaneVisibility();
UpdateVisualState();
UpdatePaneTitleMargins();
UpdatePaneLayout();
UpdatePaneOverlayGroup();
}
void UpdateRepeaterItemsSource(bool forceSelectionModelUpdate)
{
object itemsSource;
{
object init()
{
if (MenuItemsSource is { } menuItemsSource)
{
return menuItemsSource;
}
else
{
UpdateSelectionForMenuItems();
return MenuItems;
}
};
itemsSource = init();
}
// Selection Model has same representation of data regardless
// of pane mode, so only update if the ItemsSource data itself
// has changed.
if (forceSelectionModelUpdate)
{
m_selectionModelSource[0] = itemsSource;
}
m_menuItemsCollectionChangedRevoker?.Revoke();
m_menuItemsSource = new InspectingDataSource(itemsSource);
m_menuItemsCollectionChangedRevoker = new ItemsSourceView.CollectionChangedRevoker(m_menuItemsSource, OnMenuItemsSourceCollectionChanged);
if (IsTopNavigationView())
{
UpdateLeftRepeaterItemSource(null);
UpdateTopNavRepeatersItemSource(itemsSource);
InvalidateTopNavPrimaryLayout();
}
else
{
UpdateTopNavRepeatersItemSource(null);
UpdateLeftRepeaterItemSource(itemsSource);
}
}
void UpdateLeftRepeaterItemSource(object items)
{
UpdateItemsRepeaterItemsSource(m_leftNavRepeater, items);
// Left pane repeater has a new items source, update pane layout.
UpdatePaneLayout();
}
void UpdateTopNavRepeatersItemSource(object items)
{
// Change data source and setup vectors
m_topDataProvider.SetDataSource(items);
// rebinding
UpdateTopNavPrimaryRepeaterItemsSource(items);
UpdateTopNavOverflowRepeaterItemsSource(items);
}
void UpdateTopNavPrimaryRepeaterItemsSource(object items)
{
if (items != null)
{
UpdateItemsRepeaterItemsSource(m_topNavRepeater, m_topDataProvider.GetPrimaryItems());
}
else
{
UpdateItemsRepeaterItemsSource(m_topNavRepeater, null);
}
}
void UpdateTopNavOverflowRepeaterItemsSource(object items)
{
m_topNavOverflowItemsCollectionChangedRevoker?.Revoke();
if (m_topNavRepeaterOverflowView is { } overflowRepeater)
{
if (items != null)
{
var itemsSource = m_topDataProvider.GetOverflowItems();
overflowRepeater.ItemsSource = itemsSource;
// We listen to changes to the overflow menu item collection so we can set the visibility of the overflow button
// to collapsed when it no longer has any items.
//
// Normally, MeasureOverride() kicks off updating the button's visibility, however, it is not run when the overflow menu
// only contains a *single* item and we
// - either remove that menu item or
// - remove menu items displayed in the NavigationView pane until there is enough room for the single overflow menu item
// to be displayed in the pane
m_topNavOverflowItemsCollectionChangedRevoker = new ItemsSourceView.CollectionChangedRevoker(overflowRepeater.ItemsSourceView, OnOverflowItemsSourceCollectionChanged);
}
else
{
overflowRepeater.ItemsSource = null;
}
}
}
void UpdateItemsRepeaterItemsSource(ItemsRepeater ir,
object itemsSource)
{
if (ir != null)
{
ir.ItemsSource = itemsSource;
}
}
void UpdateFooterRepeaterItemsSource(bool sourceCollectionReset, bool sourceCollectionChanged)
{
if (!m_appliedTemplate) return;
object itemsSource;
{
itemsSource = init();
object init()
{
if (FooterMenuItemsSource is { } menuItemsSource)
{
return menuItemsSource;
}
UpdateSelectionForMenuItems();
return FooterMenuItems;
}
}
UpdateItemsRepeaterItemsSource(m_leftNavFooterMenuRepeater, null);
UpdateItemsRepeaterItemsSource(m_topNavFooterMenuRepeater, null);
if (m_settingsItem is null || sourceCollectionChanged || sourceCollectionReset)
{
var dataSource = new List<object>();
if (m_settingsItem is null)
{
m_settingsItem = new NavigationViewItem();
var settingsItem = m_settingsItem;
settingsItem.Name = "SettingsItem";
m_navigationViewItemsFactory.SettingsItem(settingsItem);
}
if (sourceCollectionReset)
{
if (m_footerItemsSource != null)
{
m_footerItemsSource.CollectionChanged -= OnFooterItemsSourceCollectionChanged;
}
m_footerItemsSource = null;
}
if (m_footerItemsSource is null)
{
m_footerItemsSource = new InspectingDataSource(itemsSource);
m_footerItemsCollectionChangedRevoker = new ItemsSourceView.CollectionChangedRevoker(m_footerItemsSource, OnFooterItemsSourceCollectionChanged);
}
if (m_footerItemsSource != null)
{
var settingsItem = m_settingsItem;
var size = m_footerItemsSource.Count;
for (int i = 0; i < size; i++)
{
var item = m_footerItemsSource.GetAt(i);
dataSource.Add(item);
}
if (IsSettingsVisible)
{
CreateAndHookEventsToSettings();
// add settings item to the end of footer
dataSource.Add(settingsItem);
}
}
m_selectionModelSource[1] = dataSource;
}
if (IsTopNavigationView())
{
UpdateItemsRepeaterItemsSource(m_topNavFooterMenuRepeater, m_selectionModelSource[1]);
}
else
{
if (m_leftNavFooterMenuRepeater is { } repeater)
{
UpdateItemsRepeaterItemsSource(m_leftNavFooterMenuRepeater, m_selectionModelSource[1]);
// Footer items changed and we need to recalculate the layout.
// However repeater "lags" behind, so we need to force it to reevaluate itself now.
repeater.InvalidateMeasure();
repeater.UpdateLayout();
// Footer items changed, so let's update the pane layout.
UpdatePaneLayout();
}
if (m_settingsItem is { } settings)
{
settings.BringIntoView();
}
}
}
void OnFlyoutClosing(object sender, FlyoutBaseClosingEventArgs args)
{
// If the user selected an parent item in the overflow flyout then the item has not been moved to top primary yet.
// So we need to move it.
if (m_moveTopNavOverflowItemOnFlyoutClose && !m_selectionChangeFromOverflowMenu)
{
m_moveTopNavOverflowItemOnFlyoutClose = false;
var selectedIndex = m_selectionModel.SelectedIndex;
if (selectedIndex.GetSize() > 0)
{
if (GetContainerForIndex(selectedIndex.GetAt(1), false /*infooter*/) is { } firstContainer)
{
if (firstContainer is NavigationViewItem firstNVI)
{
// We want to collapse the top level item before we move it
firstNVI.IsExpanded = false;
}
}
SelectandMoveOverflowItem(SelectedItem, selectedIndex, false /*closeFlyout*/);
}
}
}
void OnNavigationViewItemIsSelectedPropertyChanged(DependencyObject sender, DependencyProperty args)