Srujan Gaddam
877713882c
For use with createDartExport. Adds comments describing the basic use of this annotation. Change-Id: I7744b6732054e845bf405c2d64e7e458c36deab7 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/260742 Reviewed-by: Sigmund Cherem <sigmund@google.com> Reviewed-by: Riley Porter <rileyporter@google.com>
91 lines
3.5 KiB
Dart
91 lines
3.5 KiB
Dart
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
|
|
// for details. All rights reserved. Use of this source code is governed by a
|
|
// BSD-style license that can be found in the LICENSE file.
|
|
|
|
/// Annotations to mark interfaces to JavaScript.
|
|
library js;
|
|
|
|
import 'package:meta/meta.dart';
|
|
|
|
export 'dart:js' show allowInterop, allowInteropCaptureThis;
|
|
|
|
/// An annotation that indicates a library, class, or member is implemented
|
|
/// directly in JavaScript.
|
|
///
|
|
/// All external members of a class or library with this annotation implicitly
|
|
/// have it as well.
|
|
///
|
|
/// Specifying [name] customizes the JavaScript name to use. By default the
|
|
/// dart name is used. It is not valid to specify a custom [name] for class
|
|
/// instance members.
|
|
class JS {
|
|
final String? name;
|
|
const JS([this.name]);
|
|
}
|
|
|
|
class _Anonymous {
|
|
const _Anonymous();
|
|
}
|
|
|
|
class _StaticInterop {
|
|
const _StaticInterop();
|
|
}
|
|
|
|
/// An annotation that indicates a [JS] annotated class is structural and does
|
|
/// not have a known JavaScript prototype.
|
|
///
|
|
/// A class marked with [anonymous] must have an unnamed factory constructor
|
|
/// with no positional arguments, only named arguments. Invoking the constructor
|
|
/// desugars to creating a JavaScript object literal with name-value pairs
|
|
/// corresponding to the parameter names and values.
|
|
const _Anonymous anonymous = _Anonymous();
|
|
|
|
/// [staticInterop] enables the [JS] annotated class to be treated as a "static"
|
|
/// interop class.
|
|
///
|
|
/// These classes allow interop with native types, like the ones in `dart:html`.
|
|
/// These classes should not contain any instance members, inherited or
|
|
/// otherwise, and should instead use static extension members.
|
|
const _StaticInterop staticInterop = _StaticInterop();
|
|
|
|
/// NOTE: [trustTypes] is an experimental annotation that may disappear at any
|
|
/// point in time. It exists solely to help users who wish to migrate classes
|
|
/// from the older style of JS interop to the new static interop model but wish
|
|
/// to preserve the older semantics for type checks. This annotation must be
|
|
/// used alongside [staticInterop] and it affects any external methods in any
|
|
/// extension to the static interop class.
|
|
@experimental
|
|
class _TrustTypes {
|
|
const _TrustTypes();
|
|
}
|
|
|
|
const _TrustTypes trustTypes = _TrustTypes();
|
|
|
|
/// Annotation to mark Dart classes as exportable and allow instance members to
|
|
/// be wrapped with an object literal.
|
|
///
|
|
/// Dart classes with this annotation can be used for exporting in `js_util`'s
|
|
/// `createDartExport`, which returns a JS object that forwards to the Dart
|
|
/// class. You may either annotate specific instance members to only export
|
|
/// those members or you can annotate the entire class (which will export all
|
|
/// instance members) to mark the class as exportable.
|
|
///
|
|
/// Classes and mixins in the hierarchy are included only if they are annotated
|
|
/// or specific members in them are annotated. If a superclass does not have an
|
|
/// annotation anywhere, its members are not included. Only concrete instance
|
|
/// members can and will be exported, and it's an error to annotate other
|
|
/// members with this annotation. In order to do renaming for members, you can
|
|
/// provide a name for the `@JSExport` on the members e.g.
|
|
/// ```
|
|
/// class Export {
|
|
/// @JSExport('printHelloWorld')
|
|
/// void printMessage() => print('Hello World!');
|
|
/// }
|
|
/// ```
|
|
/// which will then set 'printHelloWorld' to forward to `printMessage` in the
|
|
/// object literal.
|
|
class JSExport {
|
|
final String name;
|
|
const JSExport([this.name = '']);
|
|
}
|