Google Git
Sign in
dart / web.git / 9b7e29d6e4bd2d62f82a3a55080de6976025aeb6
commit9b7e29d6e4bd2d62f82a3a55080de6976025aeb6[log] [tgz]
authorDevon Carew <devoncarew@google.com>Tue Mar 12 08:58:39 2024 -0700
committerGitHub <noreply@github.com>Tue Mar 12 08:58:39 2024 -0700
treec4d09548ff06c6c67705d002174127d6cef330e6
parent51e594b35b516b8678825e27e2f2d8051a594a57 [diff]
Add a 'sourced from mdn docs' line to the MDN sourced dartdoc (#198)

* add a 'docs from mdn' line to the interface type docs

* re-generate package files

* update the changelog; link to specific types

* review feedback
95 files changed
tree: c4d09548ff06c6c67705d002174127d6cef330e6
  1. .github/
  2. example/
  3. lib/
  4. test/
  5. test_fixes/
  6. third_party/
  7. tool/
  8. .gitignore
  9. analysis_options.yaml
  10. CHANGELOG.md
  11. LICENSE
  12. pubspec.yaml
  13. README.md
README.md

Dart CI pub package package publisher

Lightweight browser API bindings built around JS static interop.

What's this?

This package exposes browser APIs. It's generated from the Web IDL definitions and uses recent Dart language features for zero-overhead bindings.

This package is intended to replace dart:html and similar Dart SDK libraries. It will support access to browser APIs from Dart code compiled to either JavaScript or WebAssembly.

Usage

import 'package:web/web.dart';

void main() {
  final div = document.querySelector('div')!;
  div.text = 'Text set at ${DateTime.now()}';
}

Migrating to package:web

package:web is replacing dart:html and other web libraries as Dart's long-term web interop solution. To learn how to migrate from dart:html APIs to package:web, see our migration guide.

Generation conventions

The generator scripts use a number of conventions to consistently handle Web IDL definitions:

Interfaces

  • Interfaces are emitted as extension types that wrap and implement JSObject.
  • Interface inheritance is maintained using implements between extension types.
  • Members of partial interfaces, partial mixins, and mixins are added to the interfaces that include them, and therefore do not have separate declarations.

Types

  • Generic types include the generic in the case of JSArray and JSPromise.
  • Enums are typedef'd to String.
  • Callbacks and callback interfaces are typedef'd to JSFunction.
  • In general, we prefer the Dart primitive over the JS type equivalent wherever possible. For example, APIs use String instead of JSString.
  • If a type appears in a generic position and it was typedef'd to a Dart primitive type, it is replaced with the JS type equivalent to respect the type bound of JSAny?.
  • Union types are computed by picking the least upper bound of the types in the JS type hierarchy, where every interface is equivalent to JSObject.

Compatibility

  • The generator uses the MDN compatibility data to determine what members and interfaces to emit. Currently, we only emit code that is standards track and supported on Chrome, Firefox, and Safari to reduce the number of breaking changes. This is currently WIP and some members may be added or removed.

Generation and updating the package

Most of the APIs in this package are generated from public assets. See tool/README.md for information on the spec and IDL versions the package was generated from, and for the process for updating the package.