Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leocb/MaterialSkin
Theming .NET WinForms, C# or VB.Net, to Google's Material Design Principles.
https://github.com/leocb/MaterialSkin
material-design theme winforms
Last synced: 3 months ago
JSON representation
Theming .NET WinForms, C# or VB.Net, to Google's Material Design Principles.
- Host: GitHub
- URL: https://github.com/leocb/MaterialSkin
- Owner: leocb
- License: mit
- Fork: true (donaldsteele/MaterialSkin)
- Created: 2019-09-09T19:21:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T14:27:55.000Z (about 1 year ago)
- Last Synced: 2024-09-30T23:43:30.401Z (4 months ago)
- Topics: material-design, theme, winforms
- Language: C#
- Homepage:
- Size: 3.02 MB
- Stars: 439
- Watchers: 16
- Forks: 131
- Open Issues: 91
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MaterialSkin 2 for .NET WinForms
Theming .NET WinForms, C# or VB.Net, to Google's Material Design Principles.
> ⚠️ **It's NOT recommended to use this lib for new projects** ⚠️
>
> ❓For new projects I recommend [WPF with this Material Design Xaml Toolkit](https://github.com/ButchersBoy/MaterialDesignInXamlToolkit) since it's a lot newer and performant and feature complete
>
> ℹ️ The current state of this project state is: **not active**
## Contributing
- Feel free to open a PR with new features or bug fixes. Since this project is not currently active, big changes will not be considered.
- Support this and more projects by donating:
[](https://www.paypal.com/donate/?hosted_button_id=683D7S6KLX7EA)
## A quick look
## Nuget Package
A nuget package version is available [here](https://www.nuget.org/packages/MaterialSkin.2/)
Or simply search for MaterialSkin.2 on the **Nuget Package Manager** inside Visual Studio
## WIKI Available!
But there's not much in there for now, please contribute if you can. :smile:
You can access it [here](https://github.com/leocb/MaterialSkin/wiki)
## Current state of the MaterialSkin components
| Component | Supported | Disabled mode | Animated |
| ---------------------------- | :-------: | :-----------: | :------: |
| Backdrop | **No** | - | - |
| Banner | **No** | - | - |
| Buttons | Yes | Yes | Yes |
| Cards | Yes | N/A | N/A |
| Check Box | Yes | Yes | Yes |
| Check Box List | Yes | Yes | Yes |
| Chips | **No** | - | - |
| Combobox | Yes | Yes | Yes |
| Context Menu | Yes | Yes | Yes |
| Date Picker | **No** | - | - |
| Dialog | Yes | N/A | **No** |
| Divider | Yes | N/A | N/A |
| Drawer | Yes | N/A | Yes |
| Expansion Panel | Yes | Yes | **No** |
| Flexible Dialog (big) | Yes | Yes | N/A |
| FAB - Floating Action Button | Yes | Yes | Yes |
| Label | Yes | Yes | N/A |
| ListBox | Yes | Yes | N/A |
| ListView | Yes | **No** | N/A |
| Progress Bar | _Partial_ | **No** | **No** |
| Radio Button | Yes | Yes | Yes |
| Text field | Yes | Yes | Yes |
| Sliders | Yes | Yes | **No** |
| SnackBar | Yes | N/A | Yes |
| Switch | Yes | Yes | Yes |
| Tabs | Yes | N/A | Yes |
| Time Picker | **No** | - | - |
| Tooltips | **No** | - | - |
All supported components have a dark theme
## TODO List
- [ ] Progress bar - Animation and variants, maybe round loading thingy
- [ ] Backdrop (maybe)
- [ ] Some Color code improvements and refactoring
- [ ] DatePicker
- [ ] Drawer - Header, Divider, subtitle & submenu
- [ ] Textfield ContextualMenu translation
- [ ] Controls code cleanup
- [ ] Add Noto font support
---
## Contributing
Thanks for taking the time to contribute! :+1:
If you have any issues please open an issue; have an improvement? open a pull request.
> - This project was heavily updated by [@leocb](https://github.com/leocb/MaterialSkin)
> - Currently it's kept alive by [@orapps44](https://github.com/orapps44/MaterialSkin)
> - forked from [@donaldsteele](https://github.com/donaldsteele/MaterialSkin)
> - and he forked it from the original [@IgnaceMaes](https://github.com/IgnaceMaes/MaterialSkin)
## Contributors
Thank you to all the people who have already contributed to MaterialSkin 2 !
---
## Implementing MaterialSkin 2 in your application
### 1. Add the library to your project
There are a few methods to add this lib:
#### The Easy way
Search for MaterialSkin.2 on the Nuget Package manager inside VisualStudio and add it to your project.
#### Manual way
Download the precompiled DLL available on the releases section and add it as a external reference on your project.
#### Compile from the latest master
Clone the project from GitHub, then add the MaterialSkin.csproj to your own solution, then add it as a project reference on your project.
### 2. Add the MaterialSkin components to your ToolBox
Simply drag the MaterialSkin.dll file into your IDE's ToolBox and all the controls should be added there.
### 3. Inherit from MaterialForm
Open the code behind your Form you wish to skin. Make it inherit from MaterialForm rather than Form. Don't forget to put the library in your imports, so it can find the MaterialForm class!
#### C# (Form1.cs)
```cs
public partial class Form1 : MaterialForm
```
#### VB.NET (Form1.Designer.vb)
```vb
Partial Class Form1
Inherits MaterialSkin.Controls.MaterialForm
```
### 4. Initialize your colorscheme
Set your preferred colors & theme. Also add the form to the manager so it keeps updated if the color scheme or theme changes later on.
#### C# (Form1.cs)
```cs
public Form1()
{
InitializeComponent();
var materialSkinManager = MaterialSkinManager.Instance;
materialSkinManager.AddFormToManage(this);
materialSkinManager.Theme = MaterialSkinManager.Themes.LIGHT;
materialSkinManager.ColorScheme = new ColorScheme(Primary.BlueGrey800, Primary.BlueGrey900, Primary.BlueGrey500, Accent.LightBlue200, TextShade.WHITE);
}
```
#### VB.NET (Form1.vb)
```vb
Imports MaterialSkin
Public Class Form1
Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
Dim SkinManager As MaterialSkinManager = MaterialSkinManager.Instance
SkinManager.AddFormToManage(Me)
SkinManager.Theme = MaterialSkinManager.Themes.LIGHT
SkinManager.ColorScheme = New ColorScheme(Primary.BlueGrey800, Primary.BlueGrey900, Primary.BlueGrey500, Accent.LightBlue200, TextShade.WHITE)
End Sub
End Class
```
---
## Material Design in WPF
If you love .NET and Material Design, you should definitely check out [Material Design Xaml Toolkit](https://github.com/ButchersBoy/MaterialDesignInXamlToolkit) by ButchersBoy. It's a similar project but for WPF instead of WinForms.
---
## Preview!
*A simple demo interface with MaterialSkin components.*
*The MaterialSkin Drawer (menu).*
*Every MaterialSkin button variant - this is 1 control, 3 properties*
*The MaterialSkin checkboxes, radio and Switch.*
*Material skin textfield*
*Table control*
*Progress bar*
*Cards*
*List Box*
*Expansion Panel*
*Label*
*MaterialSkin using a custom color scheme.*
*FlexibleMaterial Messagebox*
