A .NET library for creating customizable splash screens in WPF applications, supporting application initialization, update management, and preloading tasks with modern UI design
Get Started
$ dotnet add package Oakrey.Applications.SplashScreenReadme
Oakrey.Applications.SplashScreen
The "SplashScreen" project is a .NET 8 WPF library designed to provide a customizable splash screen for applications. It supports application initialization, update checks, and preloading tasks, offering a modern and interactive user experience.
Features
Splash Screen UI:
SplashWindow provides a WPF-based splash screen with customizable loading text and update options. Includes buttons for skipping updates, requesting updates, and shutting down the application.
Update Management:
Integrates with MsiDeployment to check for and apply updates. Displays update progress and handles user interactions for updates.
Preloading Tasks:
Supports running multiple preloading tasks during the splash screen display.
Integration with Application Metadata:
Uses ApplicationInfo to display application-specific details like name, version, and logo.
Dependency Injection:
SplashscreenConfigurationExtension enables seamless integration with DI containers.
Logging and Telemetry:
Integrated with Oakrey.Log for logging and Oakrey.Telemetry for tracing operations.
Customizable Styles:
WindowsResources.xaml provides styles and brushes for a modern and consistent design.
Extensibility:
Implements ISplashScreenService for easy customization and testing.
Installation
You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.
NuGet Package Manager
- Open your project in Visual Studio.
- Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
- Search for
Oakrey.Applications.SplashScreenand click Install.
.NET CLI
Run the following command in your terminal:
dotnet add package Oakrey.Applications.SplashScreen
Package Manager Console
Run the following command in your Package Manager Console:
Install-Package Oakrey.Applications.SplashScreen
Requirements
- .NET 8 or higher
Project Information
- Author: Oakrey
- Company: Oakrey
- License: MIT
- Repository: Git Repository
- Project URL: Project Website
Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.
License
This project is licensed under the MIT License. See the LICENSE file for details.