Skip to content

Windows 11 settings page in WinUI 3 applications ported from Powertoys

License

Notifications You must be signed in to change notification settings

Xanliang/SettingsUI

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IDE-version nuget-version Nuget


🙌 Donate Bitcoin with Trust🙌
🙌 Donate ETH with Trust🙌

🙌 Bitcoin: bc1qzs4kt4aeqym6gsde669g5rksv4swjhzjqqp23a
🙌 ETH: 0x40Db4476c1D498b167f76A2c7ED9D45b65eb5d0C


SettingsUI

SettingsUI Helps you create your own application settings page, like Windows 11 Settings

NOTE: SettingsUI is based on WindowsAppSDK 1.0.0

Install

Install-Package SettingsUI

After installing, add the following resource to app.xaml

<ResourceDictionary Source="ms-appx:///SettingsUI/Themes/SettingsUI.xaml"/>

See the Demo app to see how to use it

SettingsUI

SettingsUI

SettingsUI

SettingsUI

SettingsUI

SettingsUI

SettingsUI

SettingsUI

Helpers

There are also a number of helpers and extensions

ContentDialogExtension

By default, only 1 ContentDialog can be opened, with the help of this extension you can open multiple ContentDialogs.

ContentDialog dialog = new ContentDialog()
{
    Title = "Title",
    Content = "Content",
    PrimaryButtonText = "OK",
    CloseButtonText = "Cancel",
    DefaultButton = ContentDialogButton.Primary,
    XamlRoot = xamlRoot
};
var result = await dialog.ShowAsyncQueue();

Observable

inherited from INotifyPropertyChanged

public class ShellViewModel : Observable
{
    private bool isBackEnabled;
    public bool IsBackEnabled
    {
        get { return isBackEnabled; }
        set { Set(ref isBackEnabled, value); }
    }
}

RelayCommand

inherited from ICommand

private ICommand itemInvokedCommand;

public ICommand ItemInvokedCommand => itemInvokedCommand ?? (itemInvokedCommand = new RelayCommand<string>(OnItemInvoked));

public void OnItemInvoked(string arg)
{

}

AutoSuggestBoxHelper

Simple helper for Loading suggestions list in AutoSuggestBox

private void AutoSuggest_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChangedEventArgs args)
{
    AutoSuggestBoxHelper.LoadSuggestions(sender, args, mylist);
}

NavHelper and ShellViewModel

Easily implement a NavigationView with Back button and AutoSuggestBox

<NavigationView
    x:Name="navigationView"
    IsBackEnabled="{x:Bind ViewModel.IsBackEnabled, Mode=OneWay}"
    ItemInvoked="navigationView_ItemInvoked"
    SelectedItem="{x:Bind ViewModel.Selected, Mode=OneWay}">
    <NavigationView.AutoSuggestBox>
        <AutoSuggestBox Name="autoSuggestBox" QueryIcon="Find" PlaceholderText="Search" TextChanged="OnControlsSearchBoxTextChanged" QuerySubmitted="OnControlsSearchBoxQuerySubmitted"/>
    </NavigationView.AutoSuggestBox>
    <NavigationView.MenuItems>
        <NavigationViewItem
            Margin="0,0,12,0"
            helpers:NavHelper.NavigateTo="views:GeneralPage"
            Content="General"/>

        <NavigationViewItem
            Margin="0,0,12,0"
            helpers:NavHelper.NavigateTo="views:AwakePage"
            Content="General"/>

        <NavigationViewItem
            Margin="0,0,12,0"
            helpers:NavHelper.NavigateTo="views:FancyZonesPage"
            Content="General"/>
    </NavigationView.MenuItems>
    <Frame x:Name="shellFrame"/>
</NavigationView>

now create a new ShellViewModel and initialize it

public ShellViewModel ViewModel { get; } = new ShellViewModel();

ViewModel.InitializeNavigation(shellFrame, navigationView)
                    .WithAutoSuggestBox(autoSuggestBox)
                    .WithKeyboardAccelerator(KeyboardAccelerators)
                    .WithDefaultPage(typeof(myPage))
                    .WithSettingsPage(typeof(mySettingsPage));

add UserControl or Page Loaded event

private void UserControl_Loaded(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
{
    ViewModel.OnLoaded();
}

private void navigationView_ItemInvoked(NavigationView sender, NavigationViewItemInvokedEventArgs args)
{
    ViewModel.OnItemInvoked(args);
}

private void OnControlsSearchBoxQuerySubmitted(AutoSuggestBox sender, AutoSuggestBoxQuerySubmittedEventArgs args)
{
    ViewModel.OnAutoSuggestBoxQuerySubmitted(args);
}

private void OnControlsSearchBoxTextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChangedEventArgs args)
{
    ViewModel.OnAutoSuggestBoxTextChanged(args);
}

if you have Microsoft.Xaml.Behaviors.WinUI.Managed nuget package, you can bind Loaded and ItemInvoked events to command

<UserControl>
    <i:Interaction.Behaviors>
        <ic:EventTriggerBehavior EventName="Loaded">
            <ic:InvokeCommandAction Command="{x:Bind ViewModel.LoadedCommand}"/>
        </ic:EventTriggerBehavior>
    </i:Interaction.Behaviors>

<NavigationView>
    <i:Interaction.Behaviors>
        <ic:EventTriggerBehavior EventName="ItemInvoked">
            <ic:InvokeCommandAction Command="{x:Bind ViewModel.ItemInvokedCommand}"/>
        </ic:EventTriggerBehavior>
    </i:Interaction.Behaviors>
</NavigationView>

<AutoSuggestBox>
    <i:Interaction.Behaviors>
        <ic:EventTriggerBehavior EventName="TextChanged">
            <ic:InvokeCommandAction Command="{x:Bind ViewModel.AutoSuggestBoxTextChangedCommand}"/>
        </ic:EventTriggerBehavior>
        <ic:EventTriggerBehavior EventName="QuerySubmitted">
            <ic:InvokeCommandAction Command="{x:Bind ViewModel.AutoSuggestBoxQuerySubmittedCommand}"/>
        </ic:EventTriggerBehavior>
    </i:Interaction.Behaviors>
</NavigationView>
</UserControl>

UpdateHelper

you can use UpdateHelper for checking application updates from github release page

first you must create a new release tag in github repository, tag version must be in this format : 1.0.0.0 now we can check for update with github username and github repository

var ver = await UpdateHelper.CheckUpdateAsync("ghost1372", "SettingsUI");
if(ver.IsExistNewVersion)
{
    Debug.WriteLine(ver.ReleaseUrl);
    Debug.WriteLine(ver.CreatedAt.ToString());
    Debug.WriteLine(ver.PublishedAt.ToString());
    
    //Asset is List so maybe there is more than one file you can use forech or increase index
    Debug.WriteLine(ver.Assets[0].Url);
    Debug.WriteLine(ver.IsPreRelease.ToString());
    Debug.WriteLine(ver.Assets[0].Size.ToString());
    Debug.WriteLine(ver.Version);
    Debug.WriteLine(ver.Changelog);
}

GeneralHelper

EnableSound

enable sound for controls

GeneralHelper.EnableSound();

GetEnum

get enum from string

var myenum = GeneralHelper.GetEnum<ElementTheme>("Dark");

IsNetworkAvailable

Check if the internet is connected or not

GeneralHelper.IsNetworkAvailable();

GetGeometry

<x:String x:Key="FavoriteGeometry">M16.4996 5.2021C16.4996 2.76017 15.3595 1.00342 13.4932 1.00342C12.467 1.00342 12.1149 1.60478 11.747 3.00299C11.6719 3.29184 11.635 3.43248 11.596 3.57109C11.495 3.92982 11.3192 4.54058 11.069 5.4021C11.0623 5.42518 11.0524 5.44692 11.0396 5.467L8.17281 9.95266C7.49476 11.0136 6.49429 11.8291 5.31841 12.2793L4.84513 12.4605C3.5984 12.9379 2.87457 14.2416 3.1287 15.5522L3.53319 17.6383C3.77462 18.8834 4.71828 19.8743 5.9501 20.1762L13.5778 22.0457C16.109 22.6661 18.6674 21.1312 19.3113 18.6059L20.7262 13.0567C21.1697 11.3174 20.1192 9.54796 18.3799 9.10449C18.1175 9.03758 17.8478 9.00373 17.5769 9.00373H15.7536C16.2497 7.37084 16.4996 6.11106 16.4996 5.2021ZM4.60127 15.2667C4.48576 14.671 4.81477 14.0783 5.38147 13.8614L5.85475 13.6802C7.33036 13.1152 8.58585 12.0918 9.43674 10.7604L12.3035 6.27477C12.3935 6.13388 12.4629 5.98082 12.5095 5.82026C12.7608 4.95525 12.9375 4.34126 13.0399 3.97737C13.083 3.82412 13.1239 3.66867 13.1976 3.3847C13.3875 2.663 13.4809 2.50342 13.4932 2.50342C14.3609 2.50342 14.9996 3.48749 14.9996 5.2021C14.9996 6.08659 14.6738 7.53754 14.0158 9.51717C13.8544 10.0027 14.2158 10.5037 14.7275 10.5037H17.5769C17.7228 10.5037 17.868 10.522 18.0093 10.558C18.9459 10.7968 19.5115 11.7496 19.2727 12.6861L17.8578 18.2353C17.4172 19.9631 15.6668 21.0133 13.9349 20.5889L6.30718 18.7193C5.64389 18.5568 5.13577 18.0232 5.00577 17.3528L4.60127 15.2667Z</x:String>

var myGeometry = GeneralHelper.GetGeometry("FavoriteGeometry");

Icon = new PathIcon { Data = myGeometry },

GetColorFromHex

var color = Application.Current.Resources["SystemAccentColor"];
var accent = Helper.GetColorFromHex(color.ToString());

About

Windows 11 settings page in WinUI 3 applications ported from Powertoys

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%