mirror of https://github.com/chylex/.NET-Community-Toolkit.git synced 2024-11-21 07:42:47 +01:00

Fork of .NET Community Toolkit. See branches for custom features.

csharp

Go to file

Sergio Pedri 96517eace8 Merge pull request #359 from CommunityToolkit/dev/fix-linker-pragma-suppressions Replace linker suppressions with attributes		2022-08-03 09:18:09 -07:00
.github	Add Nuget version requirement to bug template	2022-03-18 12:32:28 +01:00
build	Update EditorConfig and Git files	2022-06-11 15:36:02 +02:00
CommunityToolkit.Common	Merge pull request #309 from CommunityToolkit/dev/fix-fields-this-qualifier	2022-06-13 17:51:45 +02:00
CommunityToolkit.Diagnostics	Update EditorConfig and Git files	2022-06-11 15:36:02 +02:00
CommunityToolkit.HighPerformance	Merge pull request #266 from OronDF343/add-memorystream-copytoasync	2022-07-06 15:08:52 +02:00
CommunityToolkit.Mvvm	Switch __ObservableValidatorHelper to [UnconditionalSuppressMessage]	2022-08-02 19:18:52 +02:00
CommunityToolkit.Mvvm.SourceGenerators	Add aka.ms links to MVVM generator diagnostics	2022-06-28 12:26:22 +02:00
tests	Merge pull request #266 from OronDF343/add-memorystream-copytoasync	2022-07-06 15:08:52 +02:00
.editorconfig	Temporarily switch modifier preference to silent	2022-06-12 14:22:11 +02:00
.git-blame-ignore-revs	Update .git-blame-ignore-revs	2021-12-29 18:57:15 +01:00
.gitattributes	Update EditorConfig and Git files	2022-06-11 15:36:02 +02:00
.gitignore	Update EditorConfig and Git files	2022-06-11 15:36:02 +02:00
.runsettings	Port and update initial build and solution files	2021-10-29 17:54:22 +02:00
azure-pipelines.yml	Switch NBGV from install to update	2022-02-14 21:15:03 +01:00
CODE_OF_CONDUCT.md	Port and update initial build and solution files	2021-10-29 17:54:22 +02:00
Contributing.md	Port and update initial build and solution files	2021-10-29 17:54:22 +02:00
Directory.Build.props	Bump NuGet package reference versions	2022-01-13 21:53:49 +01:00
Directory.Build.targets	Rename common .props/.targets files	2021-11-01 16:36:45 +01:00
dotnet Community Toolkit.sln	Remove [Conditional] from MVVM Toolkit attributes	2022-05-09 16:11:44 +02:00
License.md	Rename packages away from "Windows" name	2021-11-01 17:26:52 +01:00
README.md	Minor formatting tweaks to the readme	2022-06-02 18:56:35 +02:00
ThirdPartyNotices.txt	Port incremental helpers from ComputeSharp	2021-12-29 18:28:34 +01:00
toolkit.snk	Port and update initial build and solution files	2021-10-29 17:54:22 +02:00
version.json	Update to reflect upcoming version	2022-01-13 10:41:27 -08:00

README.md

🧰 .NET Community Toolkit

.NET Community Toolkit is a collection of helpers and APIs that work for all .NET developers and are agnostic of any specific UI platform. The toolkit is maintained and published by Microsoft, and part of the .NET Foundation.

Target	Branch	Status	Recommended package version
Production	rel/7.1.2
Previews	main

👀 What does this repo contain?

This repository contains several .NET libraries (originally developed as part of the Windows Community Toolkit) that can be used both by application developers (regardless on the specific UI framework in use, they work everywhere!) and library authors. These libraries are also being used internally at Microsoft to power many of our first party apps (such as the new Microsoft Store) and constantly improved by listening to feedbacks from other teams, external partners and other developers from the community. Here's a quick breakdown of the various components you'll find in this repository:

CommunityToolkit.Mvvm (aka MVVM Toolkit): a fast, modular, platform-agnostic MVVM library, which is the official successor of MvvmLight. It's used extensively in the Microsoft Store and other first party apps.
CommunityToolkit.Mvvm.SourceGenerators: the source generators to augment the MVVM Toolkit.
CommunityToolkit.Diagnostics: a set of helper APIs (specifically, Guard and ThrowHelper) that can be used for cleaner, more efficient and less error-prone argument validation and error checking.
CommunityToolkit.HighPerformance a collection of helpers for working in high-performance scenarios. It includes APIs such as pooled buffer helpers, a fast string pool type, a 2D variant of Memory<T> and Span<T> (Memory2D<T> and Span2D<T>) also supporting discontiguous regions, helpers for bit shift operations (such as BitHelper, also used in Paint.NET), and more.
CommunityToolkit.Common: a set of helper APIs shared with other CommunityToolkit libraries.

🙌 Getting Started

Please read the Getting Started with the .NET Community Toolkit page for more detailed information.

📃 Documentation

All documentation for the toolkit is hosted on Microsoft Docs.

All API documentation can be found at the .NET API Browser.

🚀 Contribution

Do you want to contribute?

Check out our .NET Community Toolkit Wiki page to learn more about contribution and guidelines!

📦 NuGet Packages

NuGet is a standard package manager for .NET applications which is built into Visual Studio. When you open solution in Visual Studio, choose the Tools menu > NuGet Package Manager > Manage NuGet packages for solution… Enter one of the package names mentioned in .NET Community Toolkit NuGet Packages table to search for it online.

🌍 Roadmap

Read what we plan for next iterations, and feel free to ask questions.

Check out our Preview Packages Wiki Page to learn more about updating your NuGet sources in Visual Studio, then you can also get pre-release packages of upcoming versions to try.

📄 Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

🏢 .NET Foundation

This project is supported by the .NET Foundation.

🏆 Contributors

Made with contrib.rocks.