Permalink
104 lines (70 sloc) 9.03 KB

CefSharp Logo

Build status CefSharp.WinForms CefSharp.Wpf CefSharp.OffScreen

Got a quick question? Jump on Gitter

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.

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

If you have a simple question please start by asking it on Gitter. Please keep the Issue Tracker for Bugs only please! Before submitting a PR please read CONTRIBUTING

Stackoverflow as always is a useful resource, you can post your more complex issues here. The CefSharp Google Group is no longer active. It is however a useful resource for archived questions/answers.

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.

Note Due to so many Forks - Github can't process them through the Network Graphs Section so, if you need to do a search use the following: cefsharp fork:true and it will be able to process all of the forks.

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!

  • MyGet Pre Release
  • MyGet Pre Release
  • MyGet Pre Release

Pre-release

  • CefSharp.WinForms
  • CefSharp.Wpf
  • CefSharp.OffScreen

Stable

  • CefSharp.WinForms
  • CefSharp.Wpf
  • CefSharp.OffScreen

Release Branches

With each release a new branch is created, for example the 53.0.1 release corresponds to the cefsharp/53 branch. If you're new to CefSharp and are downloading the source to check it out, please use a Release branch

Branch CEF Version VC++ Version .Net Version Status
master 3202 2013 4.5.2 Development
cefsharp/62 3202 2013 4.5.2 Pre-Release
cefsharp/57 2987 2013 4.5.2 Release
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

Financial Support

Creating regular releases of CefSharp is a time intensive process and so to support further development we ask if can contribute financially to the next release?

Bountysource

Links

  • CefGlue: An alternative .NET CEF wrapper built using P/Invoke.
  • ChromiumFx : Another P/Invoke .Net CEF wrapper
  • CEF Forum : The official CEF Forum
  • CEF API Docs : Well worth a read if you are implementing a new feature
  • HtmlView : Visual Studio extension bringing CefSharp for showing HTML pages inside VS.