{"id":13458230,"url":"https://github.com/hardkoded/puppeteer-sharp","last_synced_at":"2025-05-13T17:03:07.605Z","repository":{"id":38083303,"uuid":"105399035","full_name":"hardkoded/puppeteer-sharp","owner":"hardkoded","description":"Headless Chrome .NET API","archived":false,"fork":false,"pushed_at":"2025-05-04T15:33:15.000Z","size":8333,"stargazers_count":3633,"open_issues_count":188,"forks_count":464,"subscribers_count":55,"default_branch":"master","last_synced_at":"2025-05-05T22:52:01.449Z","etag":null,"topics":["automation","chrome","chromium","crawler","crawling","csharp","e2e","e2e-testing","puppeteer","webautomation"],"latest_commit_sha":null,"homepage":"https://www.puppeteersharp.com","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hardkoded.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"hardkoded","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2017-09-30T20:32:25.000Z","updated_at":"2025-05-04T10:19:11.000Z","dependencies_parsed_at":"2023-12-31T17:22:39.394Z","dependency_job_id":"2a33cfc9-63e0-418e-97c6-5621cb437db1","html_url":"https://github.com/hardkoded/puppeteer-sharp","commit_stats":{"total_commits":1261,"total_committers":81,"mean_commits":"15.567901234567902","dds":"0.30452022204599527","last_synced_commit":"1b2dcca2cca1b2180914e13eeff1392236e9d482"},"previous_names":["kblok/puppeteer-sharp"],"tags_count":100,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardkoded%2Fpuppeteer-sharp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardkoded%2Fpuppeteer-sharp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardkoded%2Fpuppeteer-sharp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardkoded%2Fpuppeteer-sharp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hardkoded","download_url":"https://codeload.github.com/hardkoded/puppeteer-sharp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252590528,"owners_count":21772935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","chrome","chromium","crawler","crawling","csharp","e2e","e2e-testing","puppeteer","webautomation"],"created_at":"2024-07-31T09:00:47.996Z","updated_at":"2025-05-05T22:52:06.394Z","avatar_url":"https://github.com/hardkoded.png","language":"C#","readme":"# Puppeteer Sharp\n\n[![NuGet](https://buildstats.info/nuget/PuppeteerSharp)][NugetUrl]\n[![Build status](https://github.com/hardkoded/puppeteer-sharp/actions/workflows/dotnet.yml/badge.svg)][BuildUrl]\n[![Demo build status](https://github.com/hardkoded/puppeteer-sharp/actions/workflows/demo.yml/badge.svg)][BuildDemoUrl]\n[![CodeFactor](https://www.codefactor.io/repository/github/hardkoded/puppeteer-sharp/badge)][CodeFactorUrl]\n[![Backers](https://opencollective.com/hardkoded-projects/backers/badge.svg)][Backers]\n\n[NugetUrl]: https://www.nuget.org/packages/PuppeteerSharp/\n[BuildUrl]: https://github.com/hardkoded/puppeteer-sharp/actions/workflows/dotnet.yml\n[BuildDemoUrl]: https://github.com/hardkoded/puppeteer-sharp/actions/workflows/demo.yml\n[CodeFactorUrl]: https://www.codefactor.io/repository/github/hardkoded/puppeteer-sharp\n[Backers]: https://opencollective.com/hardkoded-projects\n\nPuppeteer Sharp is a .NET port of the official [Node.JS Puppeteer API](https://github.com/puppeteer/puppeteer).\n\n## Recent news\n\nPuppeteerSharp now supports AOT compilation! Check the [PuppeteerSharp 19 release notes!](https://github.com/hardkoded/puppeteer-sharp/releases/tag/v19.0.0).\n\n## Useful links\n\n* [API Documentation](http://www.puppeteersharp.com/api/index.html)\n* Slack channel [#puppeteer-sharp](https://www.hardkoded.com/goto/pptr-slack)\n* [StackOverflow](https://stackoverflow.com/search?q=puppeteer-sharp)\n* [Issues](https://github.com/hardkoded/puppeteer-sharp/issues?utf8=%E2%9C%93\u0026q=is%3Aissue)\n* [Blog](https://www.hardkoded.com/)\n\n## Prerequisites\n\n* Puppeteer-Sharp comes in two flavors: a NetStandard 2.0 library for .NET Framework 4.6.1 and .NET Core 2.0 or greater and a .NET 8 version.\n* If you have issues running Chrome on Linux, the Puppeteer repo has a [great troubleshooting guide](https://github.com/puppeteer/puppeteer/blob/master/docs/troubleshooting.md).\n* X-server is required on Linux.\n\n## How to Contribute and Provide Feedback\n\nSome of the best ways to contribute are to try things out file bugs and fix issues.\n\nIf you have an issue or a question:\n\n* Ask a question on [Stack Overflow](https://stackoverflow.com/search?q=puppeteer-sharp).\n* File a [new issue](https://github.com/hardkoded/puppeteer-sharp/issues/new).\n\n## Contributing Guide\n\nSee [this document](https://github.com/hardkoded/puppeteer-sharp/blob/master/CONTRIBUTING.md) for information on how to contribute.\n\n## Usage\n\n## Take screenshots\n\n\u003c!-- snippet: screenshotasync_example --\u003e\n\u003ca id='snippet-screenshotasync_example'\u003e\u003c/a\u003e\n```cs\nvar browserFetcher = new BrowserFetcher();\nawait browserFetcher.DownloadAsync();\nawait using var browser = await Puppeteer.LaunchAsync(\n    new LaunchOptions { Headless = true });\nawait using var page = await browser.NewPageAsync();\nawait page.GoToAsync(\"http://www.google.com\");\nawait page.ScreenshotAsync(outputFile);\n```\n\u003csup\u003e\u003ca href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/ScreenshotTests/PageScreenshotTests.cs#L54-L62' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-screenshotasync_example' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\nYou can also change the view port before generating the screenshot\n\n\u003c!-- snippet: setviewportasync_example --\u003e\n\u003ca id='snippet-setviewportasync_example'\u003e\u003c/a\u003e\n```cs\nawait Page.SetViewportAsync(new ViewPortOptions\n{\n    Width = 500,\n    Height = 500\n});\n```\n\u003csup\u003e\u003ca href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/ScreenshotTests/ElementHandleScreenshotTests.cs#L13-L19' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-setviewportasync_example' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n### Generate PDF files\n\n\u003c!-- snippet: pdfasync_example --\u003e\n\u003ca id='snippet-pdfasync_example'\u003e\u003c/a\u003e\n```cs\nvar browserFetcher = new BrowserFetcher();\nawait browserFetcher.DownloadAsync();\nawait using var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true });\nawait using var page = await browser.NewPageAsync();\nawait page.GoToAsync(\"http://www.google.com\"); // In case of fonts being loaded from a CDN, use WaitUntilNavigation.Networkidle0 as a second param.\nawait page.EvaluateExpressionHandleAsync(\"document.fonts.ready\"); // Wait for fonts to be loaded. Omitting this might result in no text rendered in pdf.\nawait page.PdfAsync(outputFile);\n```\n\u003csup\u003e\u003ca href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/PageTests/PdfTests.cs#L24-L34' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-pdfasync_example' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n### Inject HTML\n\n\u003c!-- snippet: setcontentasync_example --\u003e\n\u003ca id='snippet-setcontentasync_example'\u003e\u003c/a\u003e\n```cs\nawait using var page = await browser.NewPageAsync();\nawait page.SetContentAsync(\"\u003cdiv\u003eMy Receipt\u003c/div\u003e\");\nvar result = await page.GetContentAsync();\n```\n\u003csup\u003e\u003ca href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/PageTests/SetContentTests.cs#L14-L20' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-setcontentasync_example' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n### Evaluate Javascript\n\n\u003c!-- snippet: evaluate_example --\u003e\n\u003ca id='snippet-evaluate_example'\u003e\u003c/a\u003e\n```cs\nawait using var page = await browser.NewPageAsync();\nvar seven = await page.EvaluateExpressionAsync\u003cint\u003e(\"4 + 3\");\nvar someObject = await page.EvaluateFunctionAsync\u003cJsonElement\u003e(\"(value) =\u003e ({a: value})\", 5);\nConsole.WriteLine(someObject.GetProperty(\"a\").GetString());\n```\n\u003csup\u003e\u003ca href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/QuerySelectorTests/ElementHandleQuerySelectorEvalTests.cs#L17-L22' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-evaluate_example' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n### Wait For Selector\n\n```cs\nusing (var page = await browser.NewPageAsync())\n{\n    await page.GoToAsync(\"http://www.spapage.com\");\n    await page.WaitForSelectorAsync(\"div.main-content\")\n    await page.PdfAsync(outputFile));\n}\n```\n\n### Wait For Function\n\n```cs\nusing (var page = await browser.NewPageAsync())\n{\n    await page.GoToAsync(\"http://www.spapage.com\");\n    var watchDog = page.WaitForFunctionAsync(\"()=\u003e window.innerWidth \u003c 100\");\n    await page.SetViewportAsync(new ViewPortOptions { Width = 50, Height = 50 });\n    await watchDog;\n}\n```\n\n### Connect to a remote browser\n\n```cs\nvar options = new ConnectOptions()\n{\n    BrowserWSEndpoint = $\"wss://www.externalbrowser.io?token={apikey}\"\n};\n\nvar url = \"https://www.google.com/\";\n\nusing (var browser = await PuppeteerSharp.Puppeteer.ConnectAsync(options))\n{\n    using (var page = await browser.NewPageAsync())\n    {\n        await page.GoToAsync(url);\n        await page.PdfAsync(\"wot.pdf\");\n    }\n}\n```\n\n## Sponsors\n\nA massive thanks to [JetBrains](https://www.jetbrains.com/?from=PuppeteerSharp) for a community Resharper and Rider license to use on this project.\n\n\u003cdiv style=\"display:inline\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/aaubry/YamlDotNet/master/Sponsors/aws-logo-small.png\" width=\"200\" height=\"200\"/\u003e\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/en/thumb/0/08/JetBrains_beam_logo.svg/1200px-JetBrains_beam_logo.svg.png\" width=\"200\" height=\"200\"/\u003e\n\u003c/div\u003e\n\nAnd a huge thanks to everyone who sponsors this project through [Github sponsors](https://github.com/sponsors/hardkoded):\n\n\u003c!-- sponsors --\u003e\u003ca href=\"https://github.com/tolgabalci\"\u003e\u003cimg src=\"https:\u0026#x2F;\u0026#x2F;github.com\u0026#x2F;tolgabalci.png\" width=\"60px\" alt=\"User avatar: Tolga Balci\" /\u003e\u003c/a\u003e\u003ca href=\"https://github.com/nogginbox\"\u003e\u003cimg src=\"https:\u0026#x2F;\u0026#x2F;github.com\u0026#x2F;nogginbox.png\" width=\"60px\" alt=\"User avatar: Richard Garside\" /\u003e\u003c/a\u003e\u003c!-- sponsors --\u003e\n\n\n","funding_links":["https://github.com/sponsors/hardkoded","https://opencollective.com/hardkoded-projects"],"categories":["Chrome DevTools Protocol","C\\#","C#","C# #","Libraries","Office \u0026 Reports","csharp","UI Automation","Performance","UI自动化","🗒️ Cheatsheets"],"sub_categories":["Libraries for driving the protocol (or a layer above)","Testing","GUI - other","📦 Libraries"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardkoded%2Fpuppeteer-sharp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhardkoded%2Fpuppeteer-sharp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardkoded%2Fpuppeteer-sharp/lists"}