logo

AngleSharp.Js

AngleSharp.Js extends the core AngleSharp library with a .NET-based JavaScript engine.

Basic Configuration

If you just want a configuration that works you should use the following code:

var config = Configuration.Default
    .WithJs(); // from AngleSharp.Js

This will register a scripting engine for JS files. The JS parsing options and more could be set with parameters of the WithJs method.

You can also use this part with a console for logging. The call for this is WithConsoleLogger, e.g.,

var config = Configuration.Default
    .WithJs()
    .WithConsoleLogger(ctx => new MyConsoleLogger(ctx));

in the previous example MyConsoleLogger refers to a class implementing the IConsoleLogger interface. Examples of classes implementing this interface are available in our samples repository.

Extension Methods

This plugin also delivers some extension methods to be used together with elements from AngleSharp, e.g., IDocument or IElement.

For instance, the following waits until a stable point has been reached (and the document is fully available):

var context = BrowsingContext.New(config);
var document = await context.OpenAsync(address)
    .WaitUntilAvailable();

Scripts can also be run in the context of the document, where the result of the last expression is returned:

var numEntries = document.ExecuteScript("document.querySelectorAll('div').length");

Vision and Status

The repository contains DOM bindings for the Jint JavaScript engine. Jint is fully ECMAScript 5 compatible and provides the basis for evaluating JavaScripts in the context of the AngleSharp DOM representation.

The library comes with a service that exposes WithJs to IConfiguration. This enables automatic evaluation of script elements that have a valid JavaScript type (or without any explicit type, since JavaScript is the default one). The DOM bindings are generated on the fly via reflection. Since Jint is interpreting JavaScript, the library can be published in compatibility with .NET Standard (2.0). The downside is that the performance is definitely worse than any compiled JavaScript engine would deliver. For most scripts that should not be a big issue.

Features

Support of ES5 through Jint
Connection to the DOM
Evaluation of simple scripts (incl. jQuery)

Participating

Participation in the project is highly welcome. For this project the same rules as for the AngleSharp core project may be applied.

If you have any question, concern, or spot an issue then please report it before opening a pull request. An initial discussion is appreciated regardless of the nature of the problem.

Live discussions can take place in our Gitter chat, which supports using GitHub accounts.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.

For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

AngleSharp / AngleSharp.Js

readme