SharpBrowser
A full featured web-browser built using C# and CefSharp
Install / Use
/learn @sharpbrowser/SharpBrowserREADME
SharpBrowser is the fastest and most full-featured open source C# web browser there is! Slightly faster than Google Chrome when rendering web pages due to lightweight CEF renderer. We compared every available .NET browsing engine and finally settled on the high-performance CefSharp. Released under the permissive MIT license.
Features
Modern
- HTML5, CSS3, JS, Video, PDF, WebGL, WebAssembly, WebRTC, WebMIDI
- Tabbed browsing with website favicons
- Address bar (also opens Google or any search engine)
- Back, Forward, Stop, Refresh, Home, Menu button
- Print and Print to PDF
- Search bar (also highlights all instances)
- File downloads and download manager
- View online & offline webpages
- Fullscreen mode
Smart
- Hotkeys for all features
- Saves open tabs and resumes the browsing session when reopened
- Saves cookies and web cache in the
AppDatafolder - Saves application settings in a custom JSON file
- Saves favicons in a disk cache for fast reuse
- Developer tools
- Web app permission handling
- Popups open in new tabs
Extensible
- Easily add your own branding, styling, buttons or hotkeys
- Custom error pages
- Custom context menu
- Custom application main menu
- Custom settings
- Custom installer package using InnoSetup
Hotkeys
Hotkeys | Function ------------ | ------------- Ctrl+MouseWheel | Zoom in/out Ctrl+T | Add a new tab Ctrl+W | Close active tab Ctrl+MiddleClick | Close Tab F5 | Refresh active tab F11 | Toggle fullscreen F12 | Open developer tools Ctrl+Tab | Switch to the next tab Ctrl+Shift+Tab | Switch to the previous tab Ctrl+F | Open search bar (Enter to find next, Esc to close) Ctrl+P | Print Ctrl+Shift+P | Print to PDF
Documentation
- See the Compilation Guide for steps to get started.
- See the Distribution Guide to create a custom setup installer.
System requirements
-
You need .NET 8 on Windows 64-bit.
-
You need VC++ 2019 Runtime (64-bit)
-
You might need VC++ 2017 Runtime (64-bit)
-
You need to install the version of VC++ Runtime that CEFSharp needs. As per our CefSharp version, according to this, we need the above versions
Customization
-
To customize the browser branding, name, URL, default search engine, default proxy, modify the
BrowserConfigclass. -
To customize the application icon, change
sharpbrowser.icoinside theResourcesfolder. -
To customize the tab size and tab colors, modify the
BrowserTabStyleclass. -
To enable or disable Web Camera, Microphone, Javascript, WebGL, WebRTC, WebMIDI, LocalStorage, modify the
BrowserConfigclass. -
To register hotkeys for your own commands, modify the
HotkeyManagerclass. -
To register your own commands into the main menu, open the form designed for
MainFormand click theMainMenuobject. AddIconMenuItemobjects into that menu. -
To register your own commands into the page context-menu, modify
ContextMenuHandler.OnBeforeContextMenufunction, and then implement the command insideContextMenuHandler.OnContextMenuCommand. -
To setup how web app permissions are handled, modify
PermissionHandler.OnShowPermissionPrompt(some flags are already insideBrowserConfigand can easily be changed). -
To add new settings saved in the JSON file, simply call
ConfigManager.Get*andConfigManager.Setanywhere in your code. It will save into the file automatically.
Code
- SharpBrowser uses CefSharp 134 and is built on NET.
- SharpBrowser only supports Windows x64 platform.
MainForm.cs- main web browser UI and related functionalityManagers- classes that manage various types of browsing functionality, like settings, downloads and hotkeysHandlers- various handlers that we have registered with CefSharp that enable deeper integration between us and CefSharpbin- Binaries are included in thebinfolder due to the complex CefSharp setup required. Don't empty this folder.bin/storage- HTML and JS required for downloads manager and custom error pages
