Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terrier989/universal_html
Cross-platform 'dart:html'.
https://github.com/terrier989/universal_html
Last synced: about 2 months ago
JSON representation
Cross-platform 'dart:html'.
- Host: GitHub
- URL: https://github.com/terrier989/universal_html
- Owner: terrier989
- License: apache-2.0
- Fork: true (dint-dev/universal_html)
- Created: 2023-09-07T13:24:20.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2023-09-07T14:42:23.000Z (10 months ago)
- Last Synced: 2024-05-02T05:20:56.592Z (about 2 months ago)
- Language: Dart
- Homepage: https://pub.dev/packages/universal_html
- Size: 1.67 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-dart - universal_html - _dart:html_ that also works in the VM/Flutter. (Cross-platform development)
README
[](https://pub.dartlang.org/packages/universal_html)
[](https://pub.dev/packages/universal_html/publisher)
[](https://github.com/dint-dev/universal_html/actions)
# Introduction
A cross-platform `dart:html`:
* __Eases cross-platform development__
* You can use this package in browsers, mobile, desktop, and server-side VM, and Node.JS.
* Just replace `dart:html` imports with `package:universal_html/html.dart`. Normal
_dart:html_ will continue to be used when application run in browsers.
* __Extensive support for processing HTML and XML documents__
* Parse, manipulate, and print [DOM nodes](https://api.dart.dev/stable/2.19.3/dart-html/Node-class.html).
* Find DOM nodes with [querySelectorAll](https://api.dart.dev/stable/2.19.3/dart-html/querySelectorAll.html)
and other CSS query methods.
* __EventSource streaming support__
* Cross-platform _dart:html_ `EventSource` ("application/event-stream").
* If you want to customize EventSource HTTP headers outside browsers, see
[EventSourceOutsideBrowser](https://pub.dev/documentation/universal_html/latest/universal_html/EventSourceOutsideBrowser-class.html).
The project is licensed under the [Apache License 2.0](LICENSE). Some of the source code was adopted
from the original [dart:html](https://github.com/dart-lang/sdk/tree/master/tools/dom) in Dart SDK,
which is documented in the relevant files.
## Documentation
* [API reference](https://pub.dev/documentation/universal_html/latest/)
* [Github project](https://github.com/dint-dev/universal_html)
* We appreciate feedback, issue reports, and pull requests.
## Similar projects
* [universal_io](https://pub.dev/packages/universal_io) (cross-platform _dart:io_)
* [jsdom](https://www.npmjs.com/package/jsdom) (DOM implementation in Javascript)
# Getting started
## 1. Add dependency
In `pubspec.yaml`:
```yaml
dependencies:
universal_html: ^2.2.4
```
## 2. Use
```dart
import "package:universal_html/html.dart";
void main() {
// Create a DOM tree
final div = DivElement();
div.append(Element.tag("h1")
..classes.add("greeting")
..appendText("Hello world!"));
// Print outer HTML
print(div.outerHtml);
// -->
Hello world
// Do a CSS query
print(div.querySelector("div > .greeting").text);
// --> Hello world
}
```
# Examples
## Parsing HTML
Use [parseHtmlDocument](https://pub.dev/documentation/universal_html/latest/universal_html.parsing/parseHtmlDocument.html):
```dart
import 'package:universal_html/parsing.dart';
void main() {
final htmlDocument = parseHtmlDocument('...');
}
```
## Parsing XML
Use [parseXmlDocument](https://pub.dev/documentation/universal_html/latest/universal_html.parsing/parseXmlDocument.html):
```dart
import 'package:universal_html/parsing.dart';
void main() {
final xmlDocument = parseXmlDocument('...');
}
```
## Scraping a website
Load a _Window_ with [WindowController](https://pub.dev/documentation/universal_html/latest/universal_html.controller/WindowController-class.html):
```dart
import 'dart:io' show Cookie;
import 'package:universal_html/controller.dart';
Future main() async {
// Load a document.
final controller = WindowController();
controller.defaultHttpClient.userAgent = 'My Hacker News client';
await controller.openHttp(
method: 'GET',
uri: Uri.parse("https://news.ycombinator.com/"),
onRequest: (HttpClientRequest request) {
// Add custom headers
request.headers.set('Authorization', 'headerValue');
request.cookies.add(Cookie('cookieName', 'cookieValue'));
},
onResponse: (HttpClientResponse response) {
print('Status code: ${response.statusCode}');
},
);
// Select the top story using a CSS query
final titleElements = controller.document.querySelectorAll(".athing > .title");
final topStoryTitle = titleElements.first.text;
// Print result
print("Top Hacker News story is: $topStoryTitle");
}
```
## EventSource
`EventSource` ([see mozilla.org](https://developer.mozilla.org/en-US/docs/Web/API/EventSource))
is a browser API for reading "application/event-stream" streams. It has been supported by browsers
for a long time.
```dart
import 'package:universal_html/html.dart';
Future main() async {
final eventSource = EventSource('http://example.com/events');
await for (var message in event.onMessage) {
print('Event type: ${message.type}');
print('Event data: ${message.data}');
}
}
```
EventSource requests from real browsers are typically authenticated using cookies.
If you want to add cookies or customize other HTTP headers, you need to use
[EventSourceOutsideBrowser](https://pub.dev/documentation/universal_html/latest/universal_html/EventSourceOutsideBrowser-class.html):
```dart
import 'package:universal_html/universal_html.dart';
import 'dart:io' show Cookie;
Future main() async {
final eventSource = EventSource('http://example.com/events');
// The following block will NOT be executed in browsers.
// Because compiler can infer instances of EventSourceOutsideBrowser are never constructed,
// it will not appear in Javascript either.
if (eventSource is EventSourceOutsideBrowser) {
eventSource.onHttpClientRequest = (eventSource, request) {
request.headers.set('Authorization', 'example');
request.cookies.add(Cookie('name', 'value'));
};
eventSource.onHttpClientResponse = (eventSource, request, response) {
// ...
};
}
await for (var message in eventSource.onMessage) {
print('Event:');
print(' type: ${message.type}');
print(' data: ${message.data}');
}
}
```
## Testing
```dart
import 'package:universal_html/controller.dart';
import 'package:test/test.dart';
void main() {
setUp(() {
WindowController.instance = WindowController();
});
test('test #1', () {
// ...
});
test('test #2', () {
// ...
});
}
```