Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poker-sang/winui3utilities
Useful template methods for WinUI3 projects
https://github.com/poker-sang/winui3utilities
dotnet nuget windowsappsdk winui3
Last synced: 3 months ago
JSON representation
Useful template methods for WinUI3 projects
- Host: GitHub
- URL: https://github.com/poker-sang/winui3utilities
- Owner: Poker-sang
- License: mit
- Created: 2022-12-31T06:10:21.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T04:44:32.000Z (4 months ago)
- Last Synced: 2024-10-24T22:25:59.005Z (4 months ago)
- Topics: dotnet, nuget, windowsappsdk, winui3
- Language: C#
- Homepage: https://www.nuget.org/packages/WinUI3Utilities
- Size: 457 KB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WinUI3Utilities
Useful template methods for WinUI3 projects
## Build
## Usage
The following is the general usage.
For more details, see the XAML docs of the corresponding attributes.
### Available APIs
#### Helpers
| Helpers | Usage |
| - | - |
| AppHelper | Helper for `Application` |
| WindowHelper | Get and set properties of `Window` |
| WindowSizeHelper | Limit the size of the window (works with `WindowSizeHelperAttribute`) |
| DragMoveAndResizeHelper | Apply drag-move and resize function to (`UIElement`)`RootPanel` |
| DragZoneHelper | Reduce repetitive operations when using `InputNonClientPointerSource` |
| TitleBarHelper | Set title bar |
| TeachingTipHelper | Helper for `TeachingTip` |
| ContentDialogHelper | Helper for `ContentDialog` |
| Misc | Miscellaneous extension methods |
| ThrowHelper | Throw helper |
#### Attributes (Generators)
| Attributes | Usage |
| - | - |
| DependencyPropertyAttribute | Generate a dependency property |
| LocalizedStringResourcesAttribute | Generate for all the .resw and .resjson files in `PRIResource` under the specified namespace |
| $\dagger$ SettingsViewModelAttribute | Generate property according to the properties of the settings class `T` for the specified viewmodel class |
| $\dagger$ GenerateConstructorAttribute | Generate constructor like `record` for the specified type, according to the properties of it |
| $\dagger$ AppContextAttribute | Generate field `_containerConfiguration` and methods `Initialize/Load/SaveConfiguration` for the specified class |
| WindowSizeHelperAttribute | Generate helper properties to limit the window size (works with `WindowSizeHelper`) |
| AttributeIgnoreAttribute | Ignores the effect of the specified attributes on this target |
| DisableSourceGeneratorAttribute | Indicates that the source generator is disabled. This is usually used for debug purpose |
* $\dagger$: The attribute supports `AttributeIgnoreAttribute`
### Settings Persistence
**Only for packaged applications.**
AppContext.cs:
```csharp
using Microsoft.Windows.Storage;
using WinUI3Utilities.Attributes;
namespace Sample;
[AppContext]
public static partial class AppContext
{
public static string AppLocalFolder { get; private set; } = null!;
public static void Initialize()
{
AppLocalFolder = ApplicationData.GetDefault().LocalFolder.Path;
InitializeConfiguration();
AppConfig = LoadConfiguration() is not { } appConfigurations
? new() : appConfigurations;
}
public static void SetDefaultAppConfig() => AppConfig = new();
public static AppConfig AppConfig { get; private set; } = null!;
}
```
AppConfig.cs:
```csharp
using WinUI3Utilities.Attributes;
namespace Sample;
[GenerateConstructor]
public partial record AppConfig
{
public int WindowWidth { get; set; } = 1280;
public int WindowHeight { get; set; } = 720;
...
}
```
When saving configuration, you can use the following code:
```csharp
AppContext.SaveConfiguration(AppContext.AppConfig)
```
### Localization ([Reference](https://platform.uno/blog/using-msbuild-items-and-properties-in-c-9-source-generators/))
Generate for all the .resw and .resjson files in `PRIResource` under the specified namespace.
Sample.csproj
```xml
...
false
...
...
```
AssemblyInfo.cs:
```csharp
[assembly: LocalizedStringResources(nameof(Sample))]
```
XXX\APage.resw: ...
XXX\BWindow.resjson: ...
## Project Link
[](https://www.nuget.org/packages/WinUI3Utilities)
[](https://github.com/Poker-sang/WinUI3Utilities)
## Contact Me
[](mailto:[email protected])
## License
[MIT License](https://github.com/Poker-sang/WinUI3Utilities/blob/master/LICENSE)