Got a quick question? Jump on
CefSharp lets you embed Chromium in .NET apps. It is a lightweight .NET wrapper around the Chromium Embedded Framework (CEF) by Marshall A. Greenblatt. About 30% of the bindings are written in C++/CLI with the majority of code here is C#. It can be used from C# or VB, or any other CLR language. CefSharp provides both WPF and WinForms web browser control implementations.
CefSharp is BSD licensed, so it can be used in both proprietary and free/open source applications. For the full details, see the LICENSE file.
If you like and use CefSharp please consider signing up for a small monthly donation, even $25 can help tremendously. See Financial Support for more details.
Releases
Stable binaries are released on NuGet, and contain everything you need to embed Chromium in your .Net/CLR application. For usage see the Quick Start guide or FAQ #8.
Documentation
- See the CefSharp.Wpf.Example or CefSharp.WinForms.Example projects for example web browsers built with CefSharp. They demo most of the available features.
- See the CefSharp.MinimalExample project for a basic demo of using the CefSharp NuGet packages.
- See the General Usage Guide in help getting started/dealing with common scenarios.
- See the Wiki for work-in-progress documentation
- See the FAQ for help with common issues
- Upgrading from an earlier version of CefSharp? See the ChangeLog for breaking changes and upgrade tips.
- CefSharp API generated from the source code comments.
Contact
Please keep the Issue Tracker for Bugs only please! Before submitting a PR please read CONTRIBUTING.
- Stackoverflow is generally where questions should be asked, please search before posting, thanks!
- CefSharp Questions-and-Support is a repository here on
GitHubwhere you can askCefSharpspecific questions. - Chromium Embedded Framework(CEF) Forum
is the place to ask if you need a quick pointer or two.
Branches & Forks
This is the official CefSharp fork, as maintained by the CefSharp community. You can also view the entire network of public forks/branches.
Development is done in the master branch. New features are preferably added in feature branches, if the changes are more than trivial. New PR's should be targeted against master.
When a new release is imminent a release branch is created. We try to avoid making public facing API changes in release branches (Adding new features is fine, just not breaking changes).
Releases
CI Builds
Every commit on master produces a Nuget package. Use at your own risk!
Pre-release
Stable
Release Branches
With each release a new branch is created, for example the 79.1.360 release corresponds to the cefsharp/79 branch.
If you're new to CefSharp and are downloading the source to check it out, please use a Release branch.
* For .Net Core Packages VC++ 2019 is required
** For .Net Core Packages .Net Core 3.1/.Net 5.0 is required.
| Branch | CEF Version | VC++ Version | .Net Version | Status |
|---|---|---|---|---|
| master | 4472 | 2015* | 4.5.2** | Development |
| cefsharp/90 | 4430 | 2015* | 4.5.2** | Release |
| cefsharp/89 | 4389 | 2015* | 4.5.2** | Unsupported |
| cefsharp/88 | 4324 | 2015* | 4.5.2** | Unsupported |
| cefsharp/87 | 4280 | 2015* | 4.5.2** | Unsupported |
| cefsharp/86 | 4240 | 2015 | 4.5.2 | Unsupported |
| cefsharp/85 | 4183 | 2015 | 4.5.2 | Unsupported |
| cefsharp/84 | 4147 | 2015 | 4.5.2 | Unsupported |
| cefsharp/83 | 4103 | 2015 | 4.5.2 | Unsupported |
| cefsharp/81 | 4044 | 2015 | 4.5.2 | Unsupported |
| cefsharp/79 | 3945 | 2015 | 4.5.2 | Unsupported |
| cefsharp/77 | 3865 | 2015 | 4.5.2 | Unsupported |
| cefsharp/75 | 3770 | 2015 | 4.5.2 | Unsupported |
| cefsharp/73 | 3683 | 2015 | 4.5.2 | Unsupported |
| cefsharp/71 | 3578 | 2015 | 4.5.2 | Unsupported |
| cefsharp/69 | 3497 | 2015 | 4.5.2 | Unsupported |
| cefsharp/67 | 3396 | 2015 | 4.5.2 | Unsupported |
| cefsharp/65 | 3325 | 2015 | 4.5.2 | Unsupported |
| cefsharp/63 | 3239 | 2013 | 4.5.2 | Unsupported |
| cefsharp/62 | 3202 | 2013 | 4.5.2 | Unsupported |
| cefsharp/57 | 2987 | 2013 | 4.5.2 | Unsupported |
| cefsharp/55 | 2883 | 2013 | 4.5.2 | Unsupported |
| cefsharp/53 | 2785 | 2013 | 4.5.2 | Unsupported |
| cefsharp/51 | 2704 | 2013 | 4.5.2 | Unsupported |
| cefsharp/49 | 2623 | 2013 | 4.0 | Unsupported |
| cefsharp/47 | 2526 | 2013 | 4.0 | Unsupported |
| cefsharp/45 | 2454 | 2013 | 4.0 | Unsupported |
| cefsharp/43 | 2357 | 2012 | 4.0 | Unsupported |
| cefsharp/41 | 2272 | 2012 | 4.0 | Unsupported |
| cefsharp/39 | 2171 | 2012 | 4.0 | Unsupported |
| cefsharp/37 | 2062 | 2012 | 4.0 | Unsupported |
* For .Net Core Packages VC++ 2019 is required
** For .Net Core Packages .Net Core 3.1/.Net 5.0 is required.
Financial Support
To continue developing/supporting the project I (@amaitland) am asking for financial contributions. Donations of any size are greatly appreciated!
Recurring contributions can be made through GitHub Sponsors it only takes a GitHub account and a credit card. Currently GitHub is doubling(!) all pledges so is very much the preferred method of donation. I can also take contributions through PayPal.
Now that I (@amaitland) am a stay at home dad your contributions are the only reason I'm allowed to continue working on the project. Without continued funding the time I currently spend on the project will have to be put into finding other paid work.
Links
- CefGlue: An alternative .NET CEF wrapper built using P/Invoke.
- CEF Bitbucket Project : The official CEF issue tracker
- CEF Forum : The official CEF Forum
- CEF API Docs : Well worth a read if you are implementing a new feature
- CefSharp API Doc
Projects using CefSharp
- HtmlView : Visual Studio extension bringing CefSharp for showing HTML pages inside VS.
- SharpBrowser : The fastest web browser for C# with tabbed browsing and HTML5/CSS3.
- Chromely CefSharp : Build HTML Desktop Apps on .NET/.NET Core 3/.NET 5 using native GUI, HTML5/CSS.