| .github/ISSUE_TEMPLATE | ||
| cmake | ||
| include | ||
| libcef | ||
| libcef_dll | ||
| patch | ||
| tests | ||
| tools | ||
| .gitignore | ||
| .style.cfg | ||
| .style.yapf | ||
| AUTHORS.txt | ||
| BUILD.gn | ||
| cef_create_projects.bat | ||
| cef_create_projects.sh | ||
| cef_paths2.gypi | ||
| cef_paths.gypi | ||
| CHROMIUM_BUILD_COMPATIBILITY.txt | ||
| CHROMIUM_UPDATE.txt | ||
| CMakeLists.txt.in | ||
| DEPS | ||
| Doxyfile | ||
| LICENSE.txt | ||
| README.md | ||
| VERSION.in | ||
The Chromium Embedded Framework (CEF) is a simple framework for embedding Chromium-based browsers in other applications.
Quick Links
- Project Page - https://bitbucket.org/chromiumembedded/cef
- Tutorial - https://bitbucket.org/chromiumembedded/cef/wiki/Tutorial
- General Usage - https://bitbucket.org/chromiumembedded/cef/wiki/GeneralUsage
- Master Build Quick-Start - https://bitbucket.org/chromiumembedded/cef/wiki/MasterBuildQuickStart
- Branches and Building - https://bitbucket.org/chromiumembedded/cef/wiki/BranchesAndBuilding
- Announcements - https://groups.google.com/forum/#!forum/cef-announce
- Support Forum - http://www.magpcss.org/ceforum/
- Issue Tracker - https://github.com/chromiumembedded/cef/issues
- C++ API Docs - Stable release docs / Beta release docs
- Downloads - https://cef-builds.spotifycdn.com/index.html
- Donations - http://www.magpcss.org/ceforum/donate.php
Introduction
CEF is a BSD-licensed open source project founded by Marshall Greenblatt in 2008 and based on the Google Chromium project. Unlike the Chromium project itself, which focuses mainly on Google Chrome application development, CEF focuses on facilitating embedded browser use cases in third-party applications. CEF insulates the user from the underlying Chromium and Blink code complexity by offering production-quality stable APIs, release branches tracking specific Chromium releases, and binary distributions. Most features in CEF have default implementations that provide rich functionality while requiring little or no integration work from the user. There are currently over 100 million installed instances of CEF around the world embedded in products from a wide range of companies and industries. A partial list of companies and products using CEF is available on the CEF Wikipedia page. Some use cases for CEF include:
- Embedding an HTML5-compliant Web browser control in an existing native application.
- Creating a light-weight native “shell” application that hosts a user interface developed primarily using Web technologies.
- Rendering Web content “off-screen” in applications that have their own custom drawing frameworks.
- Acting as a host for automated testing of existing Web properties and applications.
CEF supports a wide range of programming languages and operating systems and can be easily integrated into both new and existing applications. It was designed from the ground up with both performance and ease of use in mind. The base framework includes C and C++ programming interfaces exposed via native libraries that insulate the host application from Chromium and Blink implementation details. It provides close integration between the browser and the host application including support for custom plugins, protocols, JavaScript objects and JavaScript extensions. The host application can optionally control resource loading, navigation, context menus, printing and more, while taking advantage of the same performance and HTML5 technologies available in the Google Chrome Web browser.
Numerous individuals and organizations contribute time and resources to support CEF development, but more involvement from the community is always welcome. This includes support for both the core CEF project and external projects that integrate CEF with additional programming languages and frameworks (see the "External Projects" section below). If you are interested in donating time to help with CEF development please see the "Helping Out" section below. If you are interested in donating money to support general CEF development and infrastructure efforts please visit the CEF Donations page.
Getting Started
Users new to CEF development should start by reading the Tutorial Wiki page for an overview of CEF usage and then proceed to the GeneralUsage Wiki page for a more in-depth discussion or architectural and usage issues. Complete API documentation is available here. CEF support and related discussion is available on the CEF Forum.
Binary Distributions
Binary distributions, which include all files necessary to build a CEF-based application, are available on the Downloads page. Binary distributions are stand-alone and do not require the download of CEF or Chromium source code. Symbol files for debugging binary distributions of libcef can also be downloaded from the above links.
Source Distributions
The CEF project is an extension of the Chromium project. CEF maintains development and release branches that track Chromium branches. CEF source code can be downloaded, built and packaged manually or with automated tools. Visit the BranchesAndBuilding Wiki page for more information.
External Projects
The base CEF framework includes support for the C and C++ programming languages. Thanks to the hard work of external maintainers CEF can integrate with a number of other programming languages and frameworks. These external projects are not maintained by CEF so please contact the respective project maintainer if you have any questions or issues.
- .Net (CEF3) - https://github.com/cefsharp/CefSharp
- .Net (CEF1) - https://bitbucket.org/fddima/cefglue
- .Net/Mono (CEF3) - https://gitlab.com/xiliumhq/chromiumembedded/cefglue
- Delphi - https://github.com/hgourvest/dcef3
- Delphi - https://github.com/salvadordf/CEF4Delphi
- Go - https://github.com/CzarekTomczak/cef2go
- Java - https://bitbucket.org/chromiumembedded/java-cef
- Python - http://code.google.com/p/cefpython/
If you're the maintainer of a project not listed above and would like your project listed here please either post to the CEF Forum or contact Marshall directly.
Helping Out
CEF is still very much a work in progress. Some ways that you can help out:
- Vote for issues in the CEF issue tracker that are important to you. This helps with development prioritization.
- Report any bugs that you find or feature requests that are important to you. Make sure to first search for existing issues before creating new ones. Please use the CEF Forum and not the issue tracker for usage questions. Each CEF issue should:
- Include the CEF revision or binary distribution version.
- Include information about your OS and compiler version.
- If the issue is a bug please provide detailed reproduction information.
- If the issue is a feature please describe why the feature is beneficial.
- Write unit tests for new or existing functionality.
- Pull requests and patches are welcome. View open issues in the CEF issue tracker or search for TODO(cef) in the source code for ideas.
If you would like to contribute source code changes to CEF please follow the below guidelines:
- Create or find an appropriate issue for each distinct bug, feature or change.
- Submit a pull request or create a patch with your changes and attach it to the CEF issue. Changes should:
- Be submitted against the current CEF master branch unless explicitly fixing a bug in a CEF release branch.
- Follow the style of existing CEF source files. In general CEF uses the Chromium C++ style guide.
- Include new or modified unit tests as appropriate to the functionality.
- Not include unnecessary or unrelated changes.