diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d6a54cf..061a229e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ allowed to contain those fields. - Empty dictionary constructors now create an empty object instead of being treated like non-object literal `external` constructors. +- Update the docs for generated interface types to reference the MDN Web Docs + project. ## 0.5.1 diff --git a/lib/src/dom/angle_instanced_arrays.dart b/lib/src/dom/angle_instanced_arrays.dart index 18b7581d..a23f7a9f 100644 --- a/lib/src/dom/angle_instanced_arrays.dart +++ b/lib/src/dom/angle_instanced_arrays.dart @@ -35,6 +35,11 @@ import 'webgl1.dart'; /// > hardware supports it and not just on Windows when using the ANGLE library. /// > "ANGLE" just indicates that this extension has been written by the ANGLE /// > library authors. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ANGLE_instanced_arrays). extension type ANGLE_instanced_arrays._(JSObject _) implements JSObject { external static GLenum get VERTEX_ATTRIB_ARRAY_DIVISOR_ANGLE; diff --git a/lib/src/dom/clipboard_apis.dart b/lib/src/dom/clipboard_apis.dart index adaeaa16..a8d91250 100644 --- a/lib/src/dom/clipboard_apis.dart +++ b/lib/src/dom/clipboard_apis.dart @@ -38,6 +38,11 @@ extension type ClipboardEventInit._(JSObject _) implements EventInit, JSObject { /// represents events providing information related to modification of the /// clipboard, that is [Element/cut_event], [Element/copy_event], and /// [Element/paste_event] events. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent). extension type ClipboardEvent._(JSObject _) implements Event, JSObject { external factory ClipboardEvent( String type, [ @@ -58,6 +63,11 @@ extension type ClipboardEvent._(JSObject _) implements Event, JSObject { /// /// > **Note:** To work with text see the [Clipboard.readText] and /// > [Clipboard.writeText] methods of the [Clipboard] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardItem). extension type ClipboardItem._(JSObject _) implements JSObject { external factory ClipboardItem( JSObject items, [ @@ -97,6 +107,11 @@ extension type ClipboardItemOptions._(JSObject _) implements JSObject { /// Additional requirements for using the API are discussed in the /// [Security consideration](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API#security_considerations) /// section of the API overview topic. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard). extension type Clipboard._(JSObject _) implements EventTarget, JSObject { /// The **`read()`** method of the [Clipboard] interface requests a copy of /// the clipboard's contents, fulfilling the returned `Promise` with the data. diff --git a/lib/src/dom/compression.dart b/lib/src/dom/compression.dart index 6653a501..45e3d711 100644 --- a/lib/src/dom/compression.dart +++ b/lib/src/dom/compression.dart @@ -19,6 +19,11 @@ typedef CompressionFormat = String; /// The **`CompressionStream`** interface of the [Compression Streams API] is an /// API for compressing a stream of data. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream). extension type CompressionStream._(JSObject _) implements JSObject { external factory CompressionStream(CompressionFormat format); @@ -28,6 +33,11 @@ extension type CompressionStream._(JSObject _) implements JSObject { /// The **`DecompressionStream`** interface of the [Compression Streams API] is /// an API for decompressing a stream of data. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream). extension type DecompressionStream._(JSObject _) implements JSObject { external factory DecompressionStream(CompressionFormat format); diff --git a/lib/src/dom/console.dart b/lib/src/dom/console.dart index 086c54a4..c5a72e8a 100644 --- a/lib/src/dom/console.dart +++ b/lib/src/dom/console.dart @@ -39,6 +39,11 @@ external $Console get console; /// > console API, such as the timer methods, may not be outputted in the /// > console of online IDEs or editors. Always open your browser's DevTools /// > console to see the logs as shown in this documentation. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/console). @JS('console') extension type $Console._(JSObject _) implements JSObject { @JS('assert') diff --git a/lib/src/dom/credential_management.dart b/lib/src/dom/credential_management.dart index 09dba0fb..a7216f94 100644 --- a/lib/src/dom/credential_management.dart +++ b/lib/src/dom/credential_management.dart @@ -31,6 +31,11 @@ typedef CredentialMediationRequirement = String; /// - [PasswordCredential] /// - [PublicKeyCredential] /// - [OTPCredential] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Credential). extension type Credential._(JSObject _) implements JSObject { external static JSPromise isConditionalMediationAvailable(); external String get id; @@ -42,6 +47,11 @@ extension type Credential._(JSObject _) implements JSObject { /// exposes methods to request credentials and notify the user agent when events /// such as successful sign in or sign out happen. This interface is accessible /// from [Navigator.credentials]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CredentialsContainer). extension type CredentialsContainer._(JSObject _) implements JSObject { /// The **`get()`** method of the [CredentialsContainer] interface returns a /// `Promise` that fulfills with a single credential instance that matches the @@ -177,6 +187,11 @@ extension type CredentialCreationOptions._(JSObject _) implements JSObject { /// /// > **Note:** This interface is restricted to top-level contexts and cannot be /// > used from an `iframe`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PasswordCredential). extension type PasswordCredential._(JSObject _) implements Credential, JSObject { external factory PasswordCredential(JSObject dataOrForm); @@ -220,6 +235,11 @@ extension type PasswordCredentialData._(JSObject _) /// /// In browsers that support it, an instance of this interface may be passed in /// the `credential` member of the `init` object for global [fetch]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FederatedCredential). extension type FederatedCredential._(JSObject _) implements Credential, JSObject { external factory FederatedCredential(FederatedCredentialInit data); diff --git a/lib/src/dom/csp.dart b/lib/src/dom/csp.dart index 8c52ee0c..2c96cdb3 100644 --- a/lib/src/dom/csp.dart +++ b/lib/src/dom/csp.dart @@ -30,6 +30,11 @@ typedef SecurityPolicyViolationEventDisposition = String; /// > or /// > [`report-to`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-to) /// > policy directive of the header. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSPViolationReportBody). extension type CSPViolationReportBody._(JSObject _) implements ReportBody, JSObject { external JSObject toJSON(); @@ -49,6 +54,11 @@ extension type CSPViolationReportBody._(JSObject _) /// The **`SecurityPolicyViolationEvent`** interface inherits from [Event], and /// represents the event object of an event sent on a document or worker when /// its content security policy is violated. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SecurityPolicyViolationEvent). extension type SecurityPolicyViolationEvent._(JSObject _) implements Event, JSObject { external factory SecurityPolicyViolationEvent( diff --git a/lib/src/dom/css_animations.dart b/lib/src/dom/css_animations.dart index 9e0088c2..9ba9debc 100644 --- a/lib/src/dom/css_animations.dart +++ b/lib/src/dom/css_animations.dart @@ -19,6 +19,11 @@ import 'dom.dart'; /// The **`AnimationEvent`** interface represents events providing information /// related to /// [animations](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_animations/Using_CSS_animations). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AnimationEvent). extension type AnimationEvent._(JSObject _) implements Event, JSObject { external factory AnimationEvent( String type, [ @@ -51,6 +56,11 @@ extension type AnimationEventInit._(JSObject _) implements EventInit, JSObject { /// of styles for a given keyframe. It corresponds to the contents of a single /// keyframe of a /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSKeyframeRule). extension type CSSKeyframeRule._(JSObject _) implements CSSRule, JSObject { external set keyText(String value); external String get keyText; @@ -61,6 +71,11 @@ extension type CSSKeyframeRule._(JSObject _) implements CSSRule, JSObject { /// complete set of keyframes for a CSS animation. It corresponds to the /// contents of a whole /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSKeyframesRule). extension type CSSKeyframesRule._(JSObject _) implements CSSRule, JSObject { /// The **`appendRule()`** method of the [CSSKeyframeRule] interface appends a /// [CSSKeyFrameRule] to the end of the rules. diff --git a/lib/src/dom/css_animations_2.dart b/lib/src/dom/css_animations_2.dart index 4a3c7bd5..58e03954 100644 --- a/lib/src/dom/css_animations_2.dart +++ b/lib/src/dom/css_animations_2.dart @@ -17,6 +17,11 @@ import 'web_animations.dart'; /// The **`CSSAnimation`** interface of the [Web Animations API] represents an /// [Animation] object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSAnimation). extension type CSSAnimation._(JSObject _) implements Animation, JSObject { external String get animationName; } diff --git a/lib/src/dom/css_cascade.dart b/lib/src/dom/css_cascade.dart index 3c80f86e..b2dd9fbf 100644 --- a/lib/src/dom/css_cascade.dart +++ b/lib/src/dom/css_cascade.dart @@ -18,6 +18,11 @@ import 'cssom.dart'; /// The **`CSSLayerBlockRule`** represents a block rule. It is a grouping /// at-rule meaning that it can contain other rules, and is associated to a /// given cascade layer, identified by its _name_. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSLayerBlockRule). extension type CSSLayerBlockRule._(JSObject _) implements CSSGroupingRule, JSObject { external String get name; @@ -33,6 +38,11 @@ extension type CSSLayerBlockRule._(JSObject _) /// statement allows the reader to understand the layer order. It also allows /// inline and imported layers to be interleaved, which is not possible when /// using the `CSSLayerBlockRule` syntax. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSLayerStatementRule). extension type CSSLayerStatementRule._(JSObject _) implements CSSRule, JSObject { external JSArray get nameList; diff --git a/lib/src/dom/css_conditional.dart b/lib/src/dom/css_conditional.dart index e08ef36e..cb2ffc58 100644 --- a/lib/src/dom/css_conditional.dart +++ b/lib/src/dom/css_conditional.dart @@ -22,12 +22,22 @@ import 'cssom.dart'; /// /// Three objects derive from `CSSConditionRule`: [CSSMediaRule], /// [CSSContainerRule] and [CSSSupportsRule]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSConditionRule). extension type CSSConditionRule._(JSObject _) implements CSSGroupingRule, JSObject { external String get conditionText; } /// The **`CSSMediaRule`** interface represents a single CSS rule. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMediaRule). extension type CSSMediaRule._(JSObject _) implements CSSConditionRule, JSObject { external MediaList get media; @@ -35,5 +45,10 @@ extension type CSSMediaRule._(JSObject _) /// The **`CSSSupportsRule`** interface represents a single CSS /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSSupportsRule). extension type CSSSupportsRule._(JSObject _) implements CSSConditionRule, JSObject {} diff --git a/lib/src/dom/css_contain_3.dart b/lib/src/dom/css_contain_3.dart index 517a01bd..66083dc8 100644 --- a/lib/src/dom/css_contain_3.dart +++ b/lib/src/dom/css_contain_3.dart @@ -21,6 +21,11 @@ import 'css_conditional.dart'; /// along with the container name if one is defined. /// Note that the container name and query together define the "condition text", /// which can be obtained using [CSSConditionRule.conditionText]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSContainerRule). extension type CSSContainerRule._(JSObject _) implements CSSConditionRule, JSObject { external String get containerName; diff --git a/lib/src/dom/css_counter_styles.dart b/lib/src/dom/css_counter_styles.dart index 5184ce88..120481c5 100644 --- a/lib/src/dom/css_counter_styles.dart +++ b/lib/src/dom/css_counter_styles.dart @@ -17,6 +17,11 @@ import 'cssom.dart'; /// The **`CSSCounterStyleRule`** interface represents an /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSCounterStyleRule). extension type CSSCounterStyleRule._(JSObject _) implements CSSRule, JSObject { external set name(String value); external String get name; diff --git a/lib/src/dom/css_font_loading.dart b/lib/src/dom/css_font_loading.dart index f1bf6686..e7914b7b 100644 --- a/lib/src/dom/css_font_loading.dart +++ b/lib/src/dom/css_font_loading.dart @@ -64,6 +64,11 @@ extension type FontFaceDescriptors._(JSObject _) implements JSObject { /// `weight`, and so on. /// For URL font sources it allows authors to trigger when the remote font is /// fetched and loaded, and to track loading status. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FontFace). extension type FontFace._(JSObject _) implements JSObject { external factory FontFace( String family, @@ -148,6 +153,11 @@ extension type FontFaceSetLoadEventInit._(JSObject _) /// ([`loadingdone`](https://developer.mozilla.org/en-US/docs/Web/API/FontFaceSet/loadingdone_event)) /// or there is an error loading one of the fonts /// ([`loadingerror`](https://developer.mozilla.org/en-US/docs/Web/API/FontFaceSet/loadingerror_event)). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FontFaceSetLoadEvent). extension type FontFaceSetLoadEvent._(JSObject _) implements Event, JSObject { external factory FontFaceSetLoadEvent( String type, [ @@ -167,6 +177,11 @@ extension type FontFaceSetLoadEvent._(JSObject _) implements Event, JSObject { /// /// This property is available as [Document.fonts], or `self.fonts` in /// [web workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FontFaceSet). extension type FontFaceSet._(JSObject _) implements EventTarget, JSObject { external factory FontFaceSet(JSArray initialFaces); diff --git a/lib/src/dom/css_fonts.dart b/lib/src/dom/css_fonts.dart index ed0bf33f..a889df27 100644 --- a/lib/src/dom/css_fonts.dart +++ b/lib/src/dom/css_fonts.dart @@ -17,6 +17,11 @@ import 'cssom.dart'; /// The **`CSSFontFaceRule`** interface represents an /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSFontFaceRule). extension type CSSFontFaceRule._(JSObject _) implements CSSRule, JSObject { external CSSStyleDeclaration get style; } @@ -25,6 +30,11 @@ extension type CSSFontFaceRule._(JSObject _) implements CSSRule, JSObject { /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule), letting /// developers assign for each font face a common name to specify features /// indices to be used in . +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSFontFeatureValuesRule). extension type CSSFontFeatureValuesRule._(JSObject _) implements CSSRule, JSObject { external set fontFamily(String value); @@ -45,6 +55,11 @@ extension type CSSFontFeatureValuesMap._(JSObject _) implements JSObject { /// The **`CSSFontPaletteValuesRule`** interface represents an /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSFontPaletteValuesRule). extension type CSSFontPaletteValuesRule._(JSObject _) implements CSSRule, JSObject { external String get name; diff --git a/lib/src/dom/css_highlight_api.dart b/lib/src/dom/css_highlight_api.dart index e48abb40..26e0534f 100644 --- a/lib/src/dom/css_highlight_api.dart +++ b/lib/src/dom/css_highlight_api.dart @@ -29,6 +29,11 @@ typedef HighlightType = String; /// A `Highlight` instance is a /// [`Set`-like object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set#set-like_browser_apis) /// that can hold one or more `Range` objects. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Highlight). extension type Highlight._(JSObject _) implements JSObject { external factory Highlight(AbstractRange initialRanges); @@ -47,4 +52,9 @@ extension type Highlight._(JSObject _) implements JSObject { /// [`Map`-like object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map#map-like_browser_apis), /// in which each key is the name string for a custom highlight, and the /// corresponding value is the associated [Highlight] object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HighlightRegistry). extension type HighlightRegistry._(JSObject _) implements JSObject {} diff --git a/lib/src/dom/css_masking.dart b/lib/src/dom/css_masking.dart index 82826801..3a21e6fb 100644 --- a/lib/src/dom/css_masking.dart +++ b/lib/src/dom/css_masking.dart @@ -18,6 +18,11 @@ import 'svg.dart'; /// The **`SVGClipPathElement`** interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGClipPathElement). extension type SVGClipPathElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGClipPathElement] using the tag 'clipPath'. @@ -33,6 +38,11 @@ extension type SVGClipPathElement._(JSObject _) /// The **`SVGMaskElement`** interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGMaskElement). extension type SVGMaskElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGMaskElement] using the tag 'mask'. SVGMaskElement() diff --git a/lib/src/dom/css_properties_values_api.dart b/lib/src/dom/css_properties_values_api.dart index b92ea12b..7936413f 100644 --- a/lib/src/dom/css_properties_values_api.dart +++ b/lib/src/dom/css_properties_values_api.dart @@ -36,6 +36,11 @@ extension type PropertyDefinition._(JSObject _) implements JSObject { /// The **`CSSPropertyRule`** interface of the /// [CSS Properties and Values API](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Properties_and_Values_API) /// represents a single CSS rule. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSPropertyRule). extension type CSSPropertyRule._(JSObject _) implements CSSRule, JSObject { external String get name; external String get syntax; diff --git a/lib/src/dom/css_transitions.dart b/lib/src/dom/css_transitions.dart index 31ac2763..b7554554 100644 --- a/lib/src/dom/css_transitions.dart +++ b/lib/src/dom/css_transitions.dart @@ -18,6 +18,11 @@ import 'dom.dart'; /// The **`TransitionEvent`** interface represents events providing information /// related to /// [transitions](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions/Using_CSS_transitions). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TransitionEvent). extension type TransitionEvent._(JSObject _) implements Event, JSObject { external factory TransitionEvent( String type, [ diff --git a/lib/src/dom/css_transitions_2.dart b/lib/src/dom/css_transitions_2.dart index 66e5cdd7..0e5e479a 100644 --- a/lib/src/dom/css_transitions_2.dart +++ b/lib/src/dom/css_transitions_2.dart @@ -19,12 +19,22 @@ import 'web_animations.dart'; /// The **`CSSStartingStyleRule`** interface of the /// [CSS Object Model](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Object_Model) /// represents a CSS at-rule. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSStartingStyleRule). extension type CSSStartingStyleRule._(JSObject _) implements CSSGroupingRule, JSObject {} /// The **`CSSTransition`** interface of the [Web Animations API] represents an /// [Animation] object used for a /// [CSS Transition](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSTransition). extension type CSSTransition._(JSObject _) implements Animation, JSObject { external String get transitionProperty; } diff --git a/lib/src/dom/css_typed_om.dart b/lib/src/dom/css_typed_om.dart index 798f7a4c..becb5a01 100644 --- a/lib/src/dom/css_typed_om.dart +++ b/lib/src/dom/css_typed_om.dart @@ -30,6 +30,11 @@ typedef CSSMathOperator = String; /// [CSS Typed Object Model API](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Object_Model#css_typed_object_model) /// is the base class of all CSS values accessible through the Typed OM API. An /// instance of this class may be used anywhere a string is expected. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleValue). extension type CSSStyleValue._(JSObject _) implements JSObject { external static CSSStyleValue parse( String property, @@ -46,6 +51,11 @@ extension type CSSStyleValue._(JSObject _) implements JSObject { /// provides a read-only representation of a CSS declaration block that is an /// alternative to [CSSStyleDeclaration]. Retrieve an instance of this interface /// using [Element.computedStyleMap]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StylePropertyMapReadOnly). extension type StylePropertyMapReadOnly._(JSObject _) implements JSObject { /// The **`get()`** method of the /// [StylePropertyMapReadOnly] interface returns a [CSSStyleValue] @@ -68,6 +78,11 @@ extension type StylePropertyMapReadOnly._(JSObject _) implements JSObject { /// [CSS Typed Object Model API](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Object_Model#css_typed_object_model_experimental) /// provides a representation of a CSS declaration block that is an alternative /// to [CSSStyleDeclaration]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StylePropertyMap). extension type StylePropertyMap._(JSObject _) implements StylePropertyMapReadOnly, JSObject { /// The **`set()`** method of the [StylePropertyMap] @@ -102,6 +117,11 @@ extension type StylePropertyMap._(JSObject _) /// /// Custom properties are represented by `CSSUnparsedValue` and `var()` /// references are represented using [CSSVariableReferenceValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSUnparsedValue). extension type CSSUnparsedValue._(JSObject _) implements CSSStyleValue, JSObject { external factory CSSUnparsedValue(JSArray members); @@ -113,6 +133,11 @@ extension type CSSUnparsedValue._(JSObject _) /// custom name for a built-in CSS value. This object functionality is sometimes /// called a "CSS variable" and serves the same purpose as the `var()` function. /// The custom name must begin with two dashes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSVariableReferenceValue). extension type CSSVariableReferenceValue._(JSObject _) implements JSObject { external factory CSSVariableReferenceValue( String variable, [ @@ -130,6 +155,11 @@ extension type CSSVariableReferenceValue._(JSObject _) implements JSObject { /// /// The interface instance name is a meaning that when used anywhere a string /// is expected it will return the value of `CSSKeyword.value`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSKeywordValue). extension type CSSKeywordValue._(JSObject _) implements CSSStyleValue, JSObject { external factory CSSKeywordValue(String value); @@ -170,6 +200,11 @@ extension type CSSNumericType._(JSObject _) implements JSObject { /// The **`CSSNumericValue`** interface of the /// [CSS Typed Object Model API](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Object_Model#css_typed_object_model) /// represents operations that all numeric values can perform. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSNumericValue). extension type CSSNumericValue._(JSObject _) implements CSSStyleValue, JSObject { external static CSSNumericValue parse(String cssText); @@ -236,6 +271,11 @@ extension type CSSNumericValue._(JSObject _) /// The **`CSSUnitValue`** interface of the represents values that contain a /// single unit type. For example, "42px" would be represented by a /// `CSSNumericValue`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSUnitValue). extension type CSSUnitValue._(JSObject _) implements CSSNumericValue, JSObject { external factory CSSUnitValue( num value, @@ -249,6 +289,11 @@ extension type CSSUnitValue._(JSObject _) implements CSSNumericValue, JSObject { /// The **`CSSMathValue`** interface of the a base class for classes /// representing complex numeric values. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMathValue). extension type CSSMathValue._(JSObject _) implements CSSNumericValue, JSObject { external CSSMathOperator get operator; } @@ -261,6 +306,11 @@ extension type CSSMathValue._(JSObject _) implements CSSNumericValue, JSObject { /// [`StylePropertyMapReadOnly.get()`](/en-US/docs/Web/API/StylePropertyMapReadOnly/get) /// method is used on a CSS property whose value is created with a /// [`calc()`](/en-US/docs/Web/CSS/calc) function. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMathSum). extension type CSSMathSum._(JSObject _) implements CSSMathValue, JSObject { external factory CSSMathSum(CSSNumberish args); @@ -271,6 +321,11 @@ extension type CSSMathSum._(JSObject _) implements CSSMathValue, JSObject { /// calling [CSSNumericValue.add], [CSSNumericValue.sub], or /// [CSSNumericValue.toSum] on [CSSNumericValue]. It inherits properties and /// methods from its parent [CSSNumericValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMathProduct). extension type CSSMathProduct._(JSObject _) implements CSSMathValue, JSObject { external factory CSSMathProduct(CSSNumberish args); @@ -279,6 +334,11 @@ extension type CSSMathProduct._(JSObject _) implements CSSMathValue, JSObject { /// The **`CSSMathNegate`** interface of the negates the value passed into it. /// It inherits properties and methods from its parent [CSSNumericValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMathNegate). extension type CSSMathNegate._(JSObject _) implements CSSMathValue, JSObject { external factory CSSMathNegate(CSSNumberish arg); @@ -288,6 +348,11 @@ extension type CSSMathNegate._(JSObject _) implements CSSMathValue, JSObject { /// The **`CSSMathInvert`** interface of the represents a CSS `calc()` used as /// `calc(1 / ).` It inherits properties and methods from its parent /// [CSSNumericValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMathInvert). extension type CSSMathInvert._(JSObject _) implements CSSMathValue, JSObject { external factory CSSMathInvert(CSSNumberish arg); @@ -296,6 +361,11 @@ extension type CSSMathInvert._(JSObject _) implements CSSMathValue, JSObject { /// The **`CSSMathMin`** interface of the represents the CSS `min()` function. /// It inherits properties and methods from its parent [CSSNumericValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMathMin). extension type CSSMathMin._(JSObject _) implements CSSMathValue, JSObject { external factory CSSMathMin(CSSNumberish args); @@ -304,6 +374,11 @@ extension type CSSMathMin._(JSObject _) implements CSSMathValue, JSObject { /// The **`CSSMathMax`** interface of the represents the CSS `max()` function. /// It inherits properties and methods from its parent [CSSNumericValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMathMax). extension type CSSMathMax._(JSObject _) implements CSSMathValue, JSObject { external factory CSSMathMax(CSSNumberish args); @@ -323,12 +398,22 @@ extension type CSSMathClamp._(JSObject _) implements CSSMathValue, JSObject { /// The **`CSSNumericArray`** interface of the contains a list of /// [CSSNumericValue] objects. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSNumericArray). extension type CSSNumericArray._(JSObject _) implements JSObject { external int get length; } /// The **`CSSTransformValue`** interface of the represents `transform-list` /// values as used by the CSS `transform` property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSTransformValue). extension type CSSTransformValue._(JSObject _) implements CSSStyleValue, JSObject { external factory CSSTransformValue(JSArray transforms); @@ -342,6 +427,11 @@ extension type CSSTransformValue._(JSObject _) /// The **`CSSTransformComponent`** interface of the is part of the /// [CSSTransformValue] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSTransformComponent). extension type CSSTransformComponent._(JSObject _) implements JSObject { /// The **`toMatrix()`** method of the /// [CSSTransformComponent] interface returns a [DOMMatrix] @@ -365,6 +455,11 @@ extension type CSSTransformComponent._(JSObject _) implements JSObject { /// [translate()](/en-US/docs/Web/CSS/transform-function/translate) value of the /// individual `transform` property in CSS. It inherits properties and methods /// from its parent [CSSTransformValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSTranslate). extension type CSSTranslate._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSTranslate( @@ -384,6 +479,11 @@ extension type CSSTranslate._(JSObject _) /// The **`CSSRotate`** interface of the represents the rotate value of the /// individual `transform` property in CSS. It inherits properties and methods /// from its parent [CSSTransformValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSRotate). extension type CSSRotate._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSRotate( @@ -408,6 +508,11 @@ extension type CSSRotate._(JSObject _) /// [scale3d()](/en-US/docs/Web/CSS/transform-function/scale3d) values of the /// individual `transform` property in CSS. It inherits properties and methods /// from its parent [CSSTransformValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSScale). extension type CSSScale._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSScale( @@ -428,6 +533,11 @@ extension type CSSScale._(JSObject _) /// interface. It represents the /// [`skew()`](/en-US/docs/Web/CSS/transform-function/skew) value of the /// individual `transform` property in CSS. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSSkew). extension type CSSSkew._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSSkew( @@ -445,6 +555,11 @@ extension type CSSSkew._(JSObject _) /// [`skewX()`](/en-US/docs/Web/CSS/transform-function/skewX) value of the /// individual `transform` property in CSS. It inherits properties and methods /// from its parent [CSSTransformValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSSkewX). extension type CSSSkewX._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSSkewX(CSSNumericValue ax); @@ -457,6 +572,11 @@ extension type CSSSkewX._(JSObject _) /// [`skewY()`](/en-US/docs/Web/CSS/transform-function/skewY) value of the /// individual `transform` property in CSS. It inherits properties and methods /// from its parent [CSSTransformValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSSkewY). extension type CSSSkewY._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSSkewY(CSSNumericValue ay); @@ -469,6 +589,11 @@ extension type CSSSkewY._(JSObject _) /// [perspective()](/en-US/docs/Web/CSS/transform-function/perspective) value of /// the individual `transform` property in CSS. It inherits properties and /// methods from its parent [CSSTransformValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSPerspective). extension type CSSPerspective._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSPerspective(CSSPerspectiveValue length); @@ -482,6 +607,11 @@ extension type CSSPerspective._(JSObject _) /// [matrix3d()](/en-US/docs/Web/CSS/transform-function/matrix3d) values of the /// individual `transform` property in CSS. It inherits properties and methods /// from its parent [CSSTransformValue]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSMatrixComponent). extension type CSSMatrixComponent._(JSObject _) implements CSSTransformComponent, JSObject { external factory CSSMatrixComponent( @@ -509,6 +639,11 @@ extension type CSSMatrixComponentOptions._(JSObject _) implements JSObject { /// [`image()`](/en-US/docs/Web/CSS/image), but not /// [`linear-gradient()`](/en-US/docs/Web/CSS/gradient/linear-gradient) or /// [`element()`](/en-US/docs/Web/CSS/element). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSImageValue). extension type CSSImageValue._(JSObject _) implements CSSStyleValue, JSObject {} extension type CSSColorValue._(JSObject _) implements CSSStyleValue, JSObject { external static JSObject parse(String cssText); diff --git a/lib/src/dom/css_view_transitions.dart b/lib/src/dom/css_view_transitions.dart index 5e05520d..0f37ffbf 100644 --- a/lib/src/dom/css_view_transitions.dart +++ b/lib/src/dom/css_view_transitions.dart @@ -25,6 +25,11 @@ typedef UpdateCallback = JSFunction; /// explained in /// [The view transition process](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API#the_view_transition_process). /// This also explains when the different promises fulfill. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ViewTransition). extension type ViewTransition._(JSObject _) implements JSObject { /// The **`skipTransition()`** method of the /// [ViewTransition] interface skips the animation part of the view diff --git a/lib/src/dom/cssom.dart b/lib/src/dom/cssom.dart index 718403e1..bc9f7af2 100644 --- a/lib/src/dom/cssom.dart +++ b/lib/src/dom/cssom.dart @@ -23,6 +23,11 @@ import 'css_typed_om.dart'; /// > **Note:** `MediaList` is a live list; updating the list using properties /// > or methods listed below will immediately update the behavior of the /// > document. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaList). extension type MediaList._(JSObject _) implements JSObject { /// The **`item()`** method of the [MediaList] interface returns the media /// query at the specified `index`, or `null` if the specified `index` doesn't @@ -45,6 +50,11 @@ extension type MediaList._(JSObject _) implements JSObject { /// An object implementing the `StyleSheet` interface represents a single style /// sheet. CSS style sheets will further implement the more specialized /// [CSSStyleSheet] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StyleSheet). extension type StyleSheet._(JSObject _) implements JSObject { external String get type; external String? get href; @@ -83,6 +93,11 @@ extension type StyleSheet._(JSObject _) implements JSObject { /// object can also be directly constructed. The constructor, and the /// [CSSStyleSheet.replace], and [CSSStyleSheet.replaceSync] methods are newer /// additions to the specification, enabling _Constructable Stylesheets_. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet). extension type CSSStyleSheet._(JSObject _) implements StyleSheet, JSObject { external factory CSSStyleSheet([CSSStyleSheetInit options]); @@ -178,6 +193,11 @@ extension type CSSStyleSheetInit._(JSObject _) implements JSObject { /// > so you can treat them like ECMAScript arrays, and at the same time impose /// > additional semantics on their usage (such as making their items /// > read-only). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StyleSheetList). extension type StyleSheetList._(JSObject _) implements JSObject { /// The **`item()`** method of the [StyleSheetList] interface returns a single /// [CSSStyleSheet] object. @@ -206,6 +226,11 @@ extension type StyleSheetList._(JSObject _) implements JSObject { /// > so you can treat them like ECMAScript arrays, and at the same time impose /// > additional semantics on their usage (such as making their items /// > read-only). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSRuleList). extension type CSSRuleList._(JSObject _) implements JSObject { /// The **`item()`** method of the [CSSRuleList] interface returns the /// [CSSRule] object at the specified `index` or `null` if the specified @@ -233,6 +258,11 @@ extension type CSSRuleList._(JSObject _) implements JSObject { /// - [CSSLayerBlockRule] /// - [CSSLayerStatementRule] /// - [CSSPropertyRule] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSRule). extension type CSSRule._(JSObject _) implements JSObject { external static int get KEYFRAMES_RULE; external static int get KEYFRAME_RULE; @@ -255,6 +285,11 @@ extension type CSSRule._(JSObject _) implements JSObject { } /// The **`CSSStyleRule`** interface represents a single CSS style rule. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleRule). extension type CSSStyleRule._(JSObject _) implements CSSGroupingRule, JSObject { external StylePropertyMap get styleMap; external set selectorText(String value); @@ -264,6 +299,11 @@ extension type CSSStyleRule._(JSObject _) implements CSSGroupingRule, JSObject { /// The **`CSSImportRule`** interface represents an /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSImportRule). extension type CSSImportRule._(JSObject _) implements CSSRule, JSObject { external String get href; external MediaList get media; @@ -277,6 +317,11 @@ extension type CSSImportRule._(JSObject _) implements CSSRule, JSObject { /// represents any CSS /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule) that /// contains other rules nested within it. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSGroupingRule). extension type CSSGroupingRule._(JSObject _) implements CSSRule, JSObject { /// The **`insertRule()`** method of the /// [CSSGroupingRule] interface adds a new CSS rule to a list of CSS rules. @@ -293,6 +338,11 @@ extension type CSSGroupingRule._(JSObject _) implements CSSRule, JSObject { } /// **`CSSPageRule`** represents a single CSS rule. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSPageRule). extension type CSSPageRule._(JSObject _) implements CSSGroupingRule, JSObject { external set selectorText(String value); external String get selectorText; @@ -306,6 +356,11 @@ extension type CSSMarginRule._(JSObject _) implements CSSRule, JSObject { /// The **`CSSNamespaceRule`** interface describes an object representing a /// single CSS /// [at-rule](https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSNamespaceRule). extension type CSSNamespaceRule._(JSObject _) implements CSSRule, JSObject { external String get namespaceURI; external String get prefix; @@ -325,6 +380,11 @@ extension type CSSNamespaceRule._(JSObject _) implements CSSRule, JSObject { /// stylesheet. /// - Via [Window.getComputedStyle], which exposes the `CSSStyleDeclaration` /// object as a **read-only** interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleDeclaration). extension type CSSStyleDeclaration._(JSObject _) implements JSObject { /// The `CSSStyleDeclaration.item()` /// method interface returns a CSS property name from a [CSSStyleDeclaration] @@ -1635,6 +1695,11 @@ external $CSS get CSS; /// The **`CSS`** interface holds useful CSS-related methods. No objects with /// this interface are implemented: it contains only static methods and is /// therefore a utilitarian interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CSS). @JS('CSS') extension type $CSS._(JSObject _) implements JSObject { external bool supports( diff --git a/lib/src/dom/cssom_view.dart b/lib/src/dom/cssom_view.dart index f72c52bf..c7815153 100644 --- a/lib/src/dom/cssom_view.dart +++ b/lib/src/dom/cssom_view.dart @@ -56,6 +56,11 @@ extension type ScrollToOptions._(JSObject _) /// observe a document to detect when its media queries change, instead of /// polling the values periodically, and allows you to programmatically make /// changes to a document based on media query status. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaQueryList). extension type MediaQueryList._(JSObject _) implements EventTarget, JSObject { /// The deprecated **`addListener()`** method of the /// [MediaQueryList] interface adds a listener to the @@ -88,6 +93,11 @@ extension type MediaQueryList._(JSObject _) implements EventTarget, JSObject { /// The `MediaQueryListEvent` object stores information on the changes that have /// happened to a [MediaQueryList] object — instances are available as the event /// object on a function referenced by a [MediaQueryList.change_event] event. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaQueryListEvent). extension type MediaQueryListEvent._(JSObject _) implements Event, JSObject { external factory MediaQueryListEvent( String type, [ @@ -118,6 +128,11 @@ extension type MediaQueryListEventInit._(JSObject _) /// /// Note that browsers determine which screen to report as current by detecting /// which screen has the center of the browser window. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Screen). extension type Screen._(JSObject _) implements JSObject { external int get availWidth; external int get availHeight; @@ -131,6 +146,11 @@ extension type Screen._(JSObject _) implements JSObject { /// The `CaretPosition` interface represents the caret position, an indicator /// for the text insertion point. You can get a `CaretPosition` using the /// [Document.caretPositionFromPoint] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CaretPosition). extension type CaretPosition._(JSObject _) implements JSObject { external DOMRect? getClientRect(); external Node get offsetNode; @@ -205,6 +225,11 @@ extension type ConvertCoordinateOptions._(JSObject _) implements JSObject { /// > `VisualViewport` object of the top-level window that's useful. For an /// > `iframe`, visual viewport metrics like [VisualViewport.width] always /// > correspond to layout viewport metrics like [Element.clientWidth]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/VisualViewport). extension type VisualViewport._(JSObject _) implements EventTarget, JSObject { external num get offsetLeft; external num get offsetTop; diff --git a/lib/src/dom/dom.dart b/lib/src/dom/dom.dart index b62baf7b..51fbcf31 100644 --- a/lib/src/dom/dom.dart +++ b/lib/src/dom/dom.dart @@ -69,6 +69,11 @@ typedef SlotAssignmentMode = String; /// such events depends on the /// [Event bubbling and capture](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events#event_bubbling_and_capture) /// settings of each handler triggered. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Event). extension type Event._(JSObject _) implements JSObject { external factory Event( String type, [ @@ -186,6 +191,11 @@ extension type EventInit._(JSObject _) implements JSObject { /// > this issue clone the object. See /// > [Share objects with page scripts](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Sharing_objects_with_page_scripts) /// > for more information. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent). extension type CustomEvent._(JSObject _) implements Event, JSObject { external factory CustomEvent( String type, [ @@ -244,6 +254,11 @@ extension type CustomEventInit._(JSObject _) implements EventInit, JSObject { /// setting /// [event handlers](https://developer.mozilla.org/en-US/docs/Web/Events/Event_handlers) /// via `onevent` properties and attributes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget). extension type EventTarget._(JSObject _) implements JSObject { external factory EventTarget(); @@ -388,6 +403,11 @@ extension type AddEventListenerOptions._(JSObject _) /// You can create a new `AbortController` object using the /// [AbortController.AbortController] constructor. Communicating with an /// asynchronous operation is done using an [AbortSignal] object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). extension type AbortController._(JSObject _) implements JSObject { external factory AbortController(); @@ -403,6 +423,11 @@ extension type AbortController._(JSObject _) implements JSObject { /// The **`AbortSignal`** interface represents a signal object that allows you /// to communicate with an asynchronous operation (such as a fetch request) and /// abort it if required via an [AbortController] object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). extension type AbortSignal._(JSObject _) implements EventTarget, JSObject { external static AbortSignal abort([JSAny? reason]); external static AbortSignal timeout(int milliseconds); @@ -434,6 +459,11 @@ extension type AbortSignal._(JSObject _) implements EventTarget, JSObject { /// > **Note:** Although `NodeList` is not an `Array`, it is possible to iterate /// > over it with `forEach()`. It can also be converted to a real `Array` using /// > `Array.from()`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NodeList). extension type NodeList._(JSObject _) implements JSObject { /// Returns a node from a /// [`NodeList`](https://developer.mozilla.org/en-US/docs/Web/API/NodeList) by @@ -467,6 +497,11 @@ extension type NodeList._(JSObject _) implements JSObject { /// > so you can treat them like ECMAScript arrays, and at the same time impose /// > additional semantics on their usage (such as making their items /// > read-only). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCollection). extension type HTMLCollection._(JSObject _) implements JSObject { /// The [HTMLCollection] method `item()` /// returns the element located at the specified offset into the collection. @@ -495,6 +530,11 @@ extension type HTMLCollection._(JSObject _) implements JSObject { /// tree. It is designed as a replacement for the older /// [Mutation Events](https://developer.mozilla.org/en-US/docs/Web/API/MutationEvent) /// feature, which was part of the DOM3 Events specification. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver). extension type MutationObserver._(JSObject _) implements JSObject { external factory MutationObserver(MutationCallback callback); @@ -565,6 +605,11 @@ extension type MutationObserverInit._(JSObject _) implements JSObject { /// The [MutationRecord] is a read-only interface that represents an individual /// DOM mutation observed by a [MutationObserver]. It is the object inside the /// array passed to the callback of a [MutationObserver]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MutationRecord). extension type MutationRecord._(JSObject _) implements JSObject { external String get type; external Node get target; @@ -598,6 +643,11 @@ extension type MutationRecord._(JSObject _) implements JSObject { /// attempting to add children to a node type that cannot have children will /// throw an /// exception. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Node). extension type Node._(JSObject _) implements EventTarget, JSObject { external static int get ELEMENT_NODE; external static int get ATTRIBUTE_NODE; @@ -833,6 +883,11 @@ external Document get document; /// API is available: HTML documents, served with the `"text/html"` content /// type, also implement the [HTMLDocument] interface, whereas XML and SVG /// documents implement the [XMLDocument] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Document). extension type Document._(JSObject _) implements Node, JSObject { external factory Document(); @@ -1587,6 +1642,11 @@ extension type Document._(JSObject _) implements Node, JSObject { /// the generic [Document] and does not add any specific methods or properties /// to it: nevertheless, several algorithms behave differently with the two /// types of documents. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XMLDocument). extension type XMLDocument._(JSObject _) implements Document, JSObject {} extension type ElementCreationOptions._(JSObject _) implements JSObject { external factory ElementCreationOptions({String is_}); @@ -1600,6 +1660,11 @@ extension type ElementCreationOptions._(JSObject _) implements JSObject { /// The **`DOMImplementation`** interface represents an object providing methods /// which are not dependent on any particular document. Such an object is /// returned by the [Document.implementation] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMImplementation). extension type DOMImplementation._(JSObject _) implements JSObject { /// The **`DOMImplementation.createDocumentType()`** method returns /// a [DocumentType] object which can either be used with @@ -1639,6 +1704,11 @@ extension type DOMImplementation._(JSObject _) implements JSObject { } /// The **`DocumentType`** interface represents a [Node] containing a doctype. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DocumentType). extension type DocumentType._(JSObject _) implements Node, JSObject { /// The **`DocumentType.before()`** method inserts a set of /// [Node] objects or strings in the children list of the @@ -1671,6 +1741,11 @@ extension type DocumentType._(JSObject _) implements Node, JSObject { /// difference is due to the fact that the document fragment isn't part of the /// active document tree structure. Changes made to the fragment don't affect /// the document. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DocumentFragment). extension type DocumentFragment._(JSObject _) implements Node, JSObject { external factory DocumentFragment(); @@ -1746,6 +1821,11 @@ extension type DocumentFragment._(JSObject _) implements Node, JSObject { /// You can retrieve a reference to an element's shadow root using its /// [Element.shadowRoot] property, provided it was created using /// [Element.attachShadow] with the `mode` option set to `open`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot). extension type ShadowRoot._(JSObject _) implements DocumentFragment, JSObject { external void setHTMLUnsafe(String html); @@ -1784,6 +1864,11 @@ extension type ShadowRoot._(JSObject _) implements DocumentFragment, JSObject { /// /// Languages outside the realm of the Web platform, like XUL through the /// `XULElement` interface, also implement `Element`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Element). extension type Element._(JSObject _) implements Node, JSObject { /// The **`insertAdjacentHTML()`** method of the /// [Element] interface parses the specified text as HTML or XML and inserts @@ -2336,6 +2421,11 @@ extension type ShadowRootInit._(JSObject _) implements JSObject { /// > **Note:** Although called `NamedNodeMap`, this interface doesn't deal with /// > [Node] objects but with [Attr] objects, which are a specialized class of /// > [Node] objects. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NamedNodeMap). extension type NamedNodeMap._(JSObject _) implements JSObject { /// The **`item()`** method of the [NamedNodeMap] interface /// returns the item in the map matching the index. @@ -2408,16 +2498,11 @@ extension type NamedNodeMap._(JSObject _) implements JSObject { /// attribute outside of a namespace, an attribute inside a namespace without a /// prefix defined, an attribute inside a namespace with a prefix: /// -/// | Attribute | Namespace name | Namespace prefix | Attribute local name | -/// Attribute qualified name | -/// | --------- | -------------- | ---------------- | -------------------- | -/// ------------------------ | -/// | `myAttr` | _none_ | _none_ | `myAttr` | -/// `myAttr` | -/// | `myAttr` | `mynamespace` | _none_ | `myAttr` | -/// `myAttr` | -/// | `myAttr` | `mynamespace` | `myns` | `myAttr` | -/// `myns:myAttr` | +/// | Attribute | Namespace name | Namespace prefix | Attribute local name | Attribute qualified name | +/// | --------- | -------------- | ---------------- | -------------------- | ------------------------ | +/// | `myAttr` | _none_ | _none_ | `myAttr` | `myAttr` | +/// | `myAttr` | `mynamespace` | _none_ | `myAttr` | `myAttr` | +/// | `myAttr` | `mynamespace` | `myns` | `myAttr` | `myns:myAttr` | /// /// > **Note:** This interface represents only attributes present in the tree /// > representation of the [Element], being a SVG, an HTML or a MathML element. @@ -2425,6 +2510,11 @@ extension type NamedNodeMap._(JSObject _) implements JSObject { /// > element, such as [HTMLTableElement] for a `table` element. (See for more /// > information about attributes and how they are _reflected_ into /// > properties.) +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Attr). extension type Attr._(JSObject _) implements Node, JSObject { external String? get namespaceURI; external String? get prefix; @@ -2441,6 +2531,11 @@ extension type Attr._(JSObject _) implements Node, JSObject { /// objects of type `CharacterData`: it is implemented by other interfaces like /// [Text], [Comment], [CDATASection], or [ProcessingInstruction], which aren't /// abstract. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CharacterData). extension type CharacterData._(JSObject _) implements Node, JSObject { /// The **`substringData()`** method of the [CharacterData] interface /// returns a portion of the existing data, @@ -2541,6 +2636,11 @@ extension type CharacterData._(JSObject _) implements Node, JSObject { /// /// Each of those text nodes is an object that has the properties and methods /// documented in this article. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Text). extension type Text._(JSObject _) implements CharacterData, JSObject { external factory Text([String data]); @@ -2605,6 +2705,11 @@ extension type Text._(JSObject _) implements CharacterData, JSObject { /// /// > **Note:** CDATA sections should not be used within HTML they are /// > considered as comments and not displayed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CDATASection). extension type CDATASection._(JSObject _) implements Text, JSObject {} /// The **`ProcessingInstruction`** interface represents a @@ -2633,6 +2738,11 @@ extension type CDATASection._(JSObject _) implements Text, JSObject {} /// ``` /// /// is a processing instruction whose `target` is `xml`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ProcessingInstruction). extension type ProcessingInstruction._(JSObject _) implements CharacterData, JSObject { external String get target; @@ -2646,6 +2756,11 @@ extension type ProcessingInstruction._(JSObject _) /// Comments are represented in HTML and XML as content between '``'. In XML, like inside SVG or MathML markup, the character sequence /// '`--`' cannot be used within a comment. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Comment). extension type Comment._(JSObject _) implements CharacterData, JSObject { external factory Comment([String data]); } @@ -2659,6 +2774,11 @@ extension type Comment._(JSObject _) implements CharacterData, JSObject { /// > [StaticRange] interfaces. To understand the difference between those two /// > interfaces, and how to choose which is appropriate for your needs, consult /// > each interface's documentation. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange). extension type AbstractRange._(JSObject _) implements JSObject { external Node get startContainer; external int get startOffset; @@ -2695,6 +2815,11 @@ extension type StaticRangeInit._(JSObject _) implements JSObject { /// /// `AbstractRange` and `StaticRange` are not available from /// [web workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StaticRange). extension type StaticRange._(JSObject _) implements AbstractRange, JSObject { external factory StaticRange(StaticRangeInit init); } @@ -2708,6 +2833,11 @@ extension type StaticRange._(JSObject _) implements AbstractRange, JSObject { /// [Document] object. /// /// There also is the [Range.Range] constructor available. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Range). extension type Range._(JSObject _) implements AbstractRange, JSObject { external factory Range(); @@ -2946,6 +3076,11 @@ extension type Range._(JSObject _) implements AbstractRange, JSObject { /// The **`NodeIterator`** interface represents an iterator to traverse nodes of /// a DOM subtree in document order. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NodeIterator). extension type NodeIterator._(JSObject _) implements JSObject { /// The **`NodeIterator.nextNode()`** method returns the next node /// in the set represented by the [NodeIterator] and advances the position of @@ -2995,6 +3130,11 @@ extension type NodeIterator._(JSObject _) implements JSObject { /// position within them. /// /// A `TreeWalker` can be created using the [Document.createTreeWalker] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker). extension type TreeWalker._(JSObject _) implements JSObject { /// The **`TreeWalker.parentNode()`** method moves the current /// [Node] to the first _visible_ ancestor node in the document order, @@ -3052,6 +3192,11 @@ extension type TreeWalker._(JSObject _) implements JSObject { /// /// A `DOMTokenList` is indexed beginning with `0` as with JavaScript `Array` /// objects. `DOMTokenList` is always case-sensitive. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMTokenList). extension type DOMTokenList._(JSObject _) implements JSObject { /// The **`item()`** method of the [DOMTokenList] interface returns an item in /// the list, @@ -3109,6 +3254,11 @@ extension type DOMTokenList._(JSObject _) implements JSObject { /// Since XPath expressions can result in a variety of result types, this /// interface makes it possible to determine and handle the type and value of /// the result. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XPathResult). extension type XPathResult._(JSObject _) implements JSObject { external static int get ANY_TYPE; external static int get NUMBER_TYPE; @@ -3151,6 +3301,11 @@ extension type XPathResult._(JSObject _) implements JSObject { /// /// Objects of this type are created by calling /// [XPathEvaluator.createExpression]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XPathExpression). extension type XPathExpression._(JSObject _) implements JSObject { /// The **`evaluate()`** method of the /// [XPathExpression] interface executes an @@ -3165,6 +3320,11 @@ extension type XPathExpression._(JSObject _) implements JSObject { } /// The `XPathEvaluator` interface allows to compile and evaluate expressions. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XPathEvaluator). extension type XPathEvaluator._(JSObject _) implements JSObject { external factory XPathEvaluator(); @@ -3207,6 +3367,11 @@ extension type XPathEvaluator._(JSObject _) implements JSObject { /// stylesheet, to /// manipulate `` parameter values, and to apply the /// transformation to documents. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XSLTProcessor). extension type XSLTProcessor._(JSObject _) implements JSObject { external factory XSLTProcessor(); diff --git a/lib/src/dom/dom_parsing.dart b/lib/src/dom/dom_parsing.dart index 31f3680e..7e324fe0 100644 --- a/lib/src/dom/dom_parsing.dart +++ b/lib/src/dom/dom_parsing.dart @@ -17,6 +17,11 @@ import 'dom.dart'; /// The `XMLSerializer` interface provides the [XMLSerializer.serializeToString] /// method to construct an XML string representing a tree. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer). extension type XMLSerializer._(JSObject _) implements JSObject { external factory XMLSerializer(); diff --git a/lib/src/dom/encoding.dart b/lib/src/dom/encoding.dart index 20f5037f..53e425f2 100644 --- a/lib/src/dom/encoding.dart +++ b/lib/src/dom/encoding.dart @@ -37,6 +37,11 @@ extension type TextDecodeOptions._(JSObject _) implements JSObject { /// The **`TextDecoder`** interface represents a decoder for a specific text /// encoding, such as `UTF-8`, `ISO-8859-2`, `KOI8-R`, `GBK`, etc. A decoder /// takes a stream of bytes as input and emits a stream of code points. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder). extension type TextDecoder._(JSObject _) implements JSObject { external factory TextDecoder([ String label, @@ -71,6 +76,11 @@ extension type TextEncoderEncodeIntoResult._(JSObject _) implements JSObject { /// The **`TextEncoder`** interface takes a stream of code points as input and /// emits a stream of UTF-8 bytes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder). extension type TextEncoder._(JSObject _) implements JSObject { external factory TextEncoder(); @@ -96,6 +106,11 @@ extension type TextEncoder._(JSObject _) implements JSObject { /// stream of text in a binary encoding, such as UTF-8 etc., to a stream of /// strings. /// It is the streaming equivalent of [TextDecoder]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream). extension type TextDecoderStream._(JSObject _) implements JSObject { external factory TextDecoderStream([ String label, @@ -112,6 +127,11 @@ extension type TextDecoderStream._(JSObject _) implements JSObject { /// The **`TextEncoderStream`** interface of the [Encoding API] converts a /// stream of strings into bytes in the UTF-8 encoding. It is the streaming /// equivalent of [TextEncoder]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoderStream). extension type TextEncoderStream._(JSObject _) implements JSObject { external factory TextEncoderStream(); diff --git a/lib/src/dom/encrypted_media.dart b/lib/src/dom/encrypted_media.dart index 90bb9937..7c66543a 100644 --- a/lib/src/dom/encrypted_media.dart +++ b/lib/src/dom/encrypted_media.dart @@ -69,6 +69,11 @@ extension type MediaKeySystemMediaCapability._(JSObject _) implements JSObject { /// provides access to a Key System for decryption and/or a content protection /// provider. You can request an instance of this object using the /// [Navigator.requestMediaKeySystemAccess] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaKeySystemAccess). extension type MediaKeySystemAccess._(JSObject _) implements JSObject { /// The `MediaKeySystemAccess.getConfiguration()` method returns an object /// with the supported combination of @@ -96,6 +101,11 @@ extension type MediaKeySystemAccess._(JSObject _) implements JSObject { /// [Encrypted Media Extensions API](https://developer.mozilla.org/en-US/docs/Web/API/Encrypted_Media_Extensions_API) /// represents a set of keys that an associated [HTMLMediaElement] can use for /// decryption of media data during playback. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaKeys). extension type MediaKeys._(JSObject _) implements JSObject { /// The `MediaKeys.createSession()` method returns a new /// [MediaKeySession] object, which represents a context for message exchange @@ -119,6 +129,11 @@ extension type MediaKeysPolicy._(JSObject _) implements JSObject { /// [Encrypted Media Extensions API](https://developer.mozilla.org/en-US/docs/Web/API/Encrypted_Media_Extensions_API) /// represents a context for message exchange with a content decryption module /// (CDM). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaKeySession). extension type MediaKeySession._(JSObject _) implements EventTarget, JSObject { /// The `MediaKeySession.generateRequest()` method returns a /// `Promise` after generating a media request based on initialization data. @@ -159,6 +174,11 @@ extension type MediaKeySession._(JSObject _) implements EventTarget, JSObject { /// The **`MediaKeyStatusMap`** interface of the /// [Encrypted Media Extensions API](https://developer.mozilla.org/en-US/docs/Web/API/Encrypted_Media_Extensions_API) /// is a read-only map of media key statuses by key IDs. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaKeyStatusMap). extension type MediaKeyStatusMap._(JSObject _) implements JSObject { /// The **`has`** property of the /// [MediaKeyStatusMap] interface returns a `Boolean`, asserting @@ -176,6 +196,11 @@ extension type MediaKeyStatusMap._(JSObject _) implements JSObject { /// [Encrypted Media Extensions API](https://developer.mozilla.org/en-US/docs/Web/API/Encrypted_Media_Extensions_API) /// contains the content and related data when the content decryption module /// generates a message for the session. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaKeyMessageEvent). extension type MediaKeyMessageEvent._(JSObject _) implements Event, JSObject { external factory MediaKeyMessageEvent( String type, @@ -206,6 +231,11 @@ extension type MediaKeyMessageEventInit._(JSObject _) /// contains the information associated with an /// [HTMLMediaElement/encrypted_event] event sent to a [HTMLMediaElement] when /// some initialization data is encountered in the media. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaEncryptedEvent). extension type MediaEncryptedEvent._(JSObject _) implements Event, JSObject { external factory MediaEncryptedEvent( String type, [ diff --git a/lib/src/dom/entries_api.dart b/lib/src/dom/entries_api.dart index 25c6f2ba..07d03d6a 100644 --- a/lib/src/dom/entries_api.dart +++ b/lib/src/dom/entries_api.dart @@ -24,6 +24,11 @@ typedef FileCallback = JSFunction; /// interface). It includes methods for working with files—including copying, /// moving, removing, and reading files—as well as information about a file it /// points to—including the file name and its path from the root to the entry. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemEntry). extension type FileSystemEntry._(JSObject _) implements JSObject { /// The [FileSystemEntry] interface's method /// **`getParent()`** obtains a @@ -44,6 +49,11 @@ extension type FileSystemEntry._(JSObject _) implements JSObject { /// represents a directory in a file system. It provides methods which make it /// possible to access and manipulate the files in a directory, as well as to /// access the entries within the directory. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemDirectoryEntry). extension type FileSystemDirectoryEntry._(JSObject _) implements FileSystemEntry, JSObject { /// The [FileSystemDirectoryEntry] interface's method @@ -93,6 +103,11 @@ extension type FileSystemFlags._(JSObject _) implements JSObject { /// lets you access the [FileSystemFileEntry]-based objects (generally /// [FileSystemFileEntry] or [FileSystemDirectoryEntry]) representing each entry /// in a directory. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemDirectoryReader). extension type FileSystemDirectoryReader._(JSObject _) implements JSObject { /// The [FileSystemDirectoryReader] interface's **`readEntries()`** method /// retrieves the directory entries @@ -114,6 +129,11 @@ extension type FileSystemDirectoryReader._(JSObject _) implements JSObject { /// represents a file in a file system. It offers properties describing the /// file's attributes, as well as the [FileSystemFileEntry.file] method, which /// creates a [File] object that can be used to read the file. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemFileEntry). extension type FileSystemFileEntry._(JSObject _) implements FileSystemEntry, JSObject { /// The [FileSystemFileEntry] interface's method @@ -138,6 +158,11 @@ extension type FileSystemFileEntry._(JSObject _) /// example by installing a Chrome extension. The relevant Chrome API can be /// found /// [here](https://developer.chrome.com/docs/extensions/reference/fileSystem/). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystem). extension type FileSystem._(JSObject _) implements JSObject { external String get name; external FileSystemDirectoryEntry get root; diff --git a/lib/src/dom/fetch.dart b/lib/src/dom/fetch.dart index 9b1e1ff9..1228f16a 100644 --- a/lib/src/dom/fetch.dart +++ b/lib/src/dom/fetch.dart @@ -63,6 +63,11 @@ typedef ResponseType = String; /// > **Note:** you can find out more about the available headers by reading our /// > [HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers) /// > reference. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Headers). extension type Headers._(JSObject _) implements JSObject { external factory Headers([HeadersInit init]); @@ -161,6 +166,11 @@ extension type Headers._(JSObject _) implements JSObject { /// constructor, but you are more likely to encounter a `Request` object being /// returned as the result of another API operation, such as a service worker /// [FetchEvent.request]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Request). extension type Request._(JSObject _) implements JSObject { external factory Request( RequestInfo input, [ @@ -293,6 +303,11 @@ extension type RequestInit._(JSObject _) implements JSObject { /// constructor, but you are more likely to encounter a `Response` object being /// returned as the result of another API operation—for example, a service /// worker [FetchEvent.respondWith], or a simple [fetch]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Response). extension type Response._(JSObject _) implements JSObject { external factory Response([ BodyInit? body, diff --git a/lib/src/dom/fileapi.dart b/lib/src/dom/fileapi.dart index 556ff916..162b6947 100644 --- a/lib/src/dom/fileapi.dart +++ b/lib/src/dom/fileapi.dart @@ -28,6 +28,11 @@ typedef EndingType = String; /// Blobs can represent data that isn't necessarily in a JavaScript-native /// format. The [File] interface is based on `Blob`, inheriting blob /// functionality and expanding it to support files on the user's system. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Blob). extension type Blob._(JSObject _) implements JSObject { external factory Blob([ JSArray blobParts, @@ -90,6 +95,11 @@ extension type BlobPropertyBag._(JSObject _) implements JSObject { /// See /// [Using files from web applications](https://developer.mozilla.org/en-US/docs/Web/API/File_API/Using_files_from_web_applications) /// for more information and examples. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/File). extension type File._(JSObject _) implements Blob, JSObject { external factory File( JSArray fileBits, @@ -141,6 +151,11 @@ extension type FilePropertyBag._(JSObject _) /// > so you can treat them like ECMAScript arrays, and at the same time impose /// > additional semantics on their usage (such as making their items /// > read-only). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileList). extension type FileList._(JSObject _) implements JSObject { /// The **`item()`** method of the [FileList] interface returns a [File] /// object representing the file at the specified index in the file list. @@ -165,6 +180,11 @@ extension type FileList._(JSObject _) implements JSObject { /// To read server-side files, use [fetch], with /// [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) permission if /// reading cross-domain. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileReader). extension type FileReader._(JSObject _) implements EventTarget, JSObject { external factory FileReader(); @@ -265,6 +285,11 @@ extension type FileReader._(JSObject _) implements EventTarget, JSObject { /// [only available](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Functions_and_classes_available_to_workers) /// in [workers](https://developer.mozilla.org/en-US/docs/Web/API/Worker) as it /// enables synchronous I/O that could potentially block. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileReaderSync). extension type FileReaderSync._(JSObject _) implements JSObject { external factory FileReaderSync(); diff --git a/lib/src/dom/filter_effects.dart b/lib/src/dom/filter_effects.dart index dac019c4..deb31c1f 100644 --- a/lib/src/dom/filter_effects.dart +++ b/lib/src/dom/filter_effects.dart @@ -18,6 +18,11 @@ import 'svg.dart'; /// The **`SVGFilterElement`** interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFilterElement). extension type SVGFilterElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFilterElement] using the tag 'filter'. SVGFilterElement() @@ -36,6 +41,11 @@ extension type SVGFilterElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGFEBlendElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEBlendElement). extension type SVGFEBlendElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEBlendElement] using the tag 'feBlend'. SVGFEBlendElement() @@ -72,6 +82,11 @@ extension type SVGFEBlendElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGFEColorMatrixElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEColorMatrixElement). extension type SVGFEColorMatrixElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEColorMatrixElement] using the tag 'feColorMatrix'. @@ -98,6 +113,11 @@ extension type SVGFEColorMatrixElement._(JSObject _) /// The **`SVGFEComponentTransferElement`** interface corresponds to the /// element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEComponentTransferElement). extension type SVGFEComponentTransferElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEComponentTransferElement] using the tag @@ -118,6 +138,11 @@ extension type SVGFEComponentTransferElement._(JSObject _) /// The **`SVGComponentTransferFunctionElement`** interface defines a base /// interface used by the component transfer function interfaces. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGComponentTransferFunctionElement). extension type SVGComponentTransferFunctionElement._(JSObject _) implements SVGElement, JSObject { external static int get SVG_FECOMPONENTTRANSFER_TYPE_UNKNOWN; @@ -136,6 +161,11 @@ extension type SVGComponentTransferFunctionElement._(JSObject _) } /// The **`SVGFEFuncRElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEFuncRElement). extension type SVGFEFuncRElement._(JSObject _) implements SVGComponentTransferFunctionElement, JSObject { /// Creates an [SVGFEFuncRElement] using the tag 'feFuncR'. @@ -147,6 +177,11 @@ extension type SVGFEFuncRElement._(JSObject _) } /// The **`SVGFEFuncGElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEFuncGElement). extension type SVGFEFuncGElement._(JSObject _) implements SVGComponentTransferFunctionElement, JSObject { /// Creates an [SVGFEFuncGElement] using the tag 'feFuncG'. @@ -158,6 +193,11 @@ extension type SVGFEFuncGElement._(JSObject _) } /// The **`SVGFEFuncBElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEFuncBElement). extension type SVGFEFuncBElement._(JSObject _) implements SVGComponentTransferFunctionElement, JSObject { /// Creates an [SVGFEFuncBElement] using the tag 'feFuncB'. @@ -169,6 +209,11 @@ extension type SVGFEFuncBElement._(JSObject _) } /// The **`SVGFEFuncAElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEFuncAElement). extension type SVGFEFuncAElement._(JSObject _) implements SVGComponentTransferFunctionElement, JSObject { /// Creates an [SVGFEFuncAElement] using the tag 'feFuncA'. @@ -180,6 +225,11 @@ extension type SVGFEFuncAElement._(JSObject _) } /// The **`SVGFECompositeElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFECompositeElement). extension type SVGFECompositeElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFECompositeElement] using the tag 'feComposite'. @@ -211,6 +261,11 @@ extension type SVGFECompositeElement._(JSObject _) } /// The **`SVGFEConvolveMatrixElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEConvolveMatrixElement). extension type SVGFEConvolveMatrixElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEConvolveMatrixElement] using the tag 'feConvolveMatrix'. @@ -244,6 +299,11 @@ extension type SVGFEConvolveMatrixElement._(JSObject _) } /// The **`SVGFEDiffuseLightingElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEDiffuseLightingElement). extension type SVGFEDiffuseLightingElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEDiffuseLightingElement] using the tag @@ -267,6 +327,11 @@ extension type SVGFEDiffuseLightingElement._(JSObject _) } /// The **`SVGFEDistantLightElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEDistantLightElement). extension type SVGFEDistantLightElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEDistantLightElement] using the tag 'feDistantLight'. @@ -281,6 +346,11 @@ extension type SVGFEDistantLightElement._(JSObject _) } /// The **`SVGFEPointLightElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEPointLightElement). extension type SVGFEPointLightElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEPointLightElement] using the tag 'fePointLight'. @@ -296,6 +366,11 @@ extension type SVGFEPointLightElement._(JSObject _) } /// The **`SVGFESpotLightElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFESpotLightElement). extension type SVGFESpotLightElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFESpotLightElement] using the tag 'feSpotLight'. @@ -316,6 +391,11 @@ extension type SVGFESpotLightElement._(JSObject _) } /// The **`SVGFEDisplacementMapElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEDisplacementMapElement). extension type SVGFEDisplacementMapElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEDisplacementMapElement] using the tag @@ -344,6 +424,11 @@ extension type SVGFEDisplacementMapElement._(JSObject _) } /// The **`SVGFEDropShadowElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEDropShadowElement). extension type SVGFEDropShadowElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEDropShadowElement] using the tag 'feDropShadow'. @@ -370,6 +455,11 @@ extension type SVGFEDropShadowElement._(JSObject _) } /// The **`SVGFEFloodElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEFloodElement). extension type SVGFEFloodElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEFloodElement] using the tag 'feFlood'. SVGFEFloodElement() @@ -386,6 +476,11 @@ extension type SVGFEFloodElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGFEGaussianBlurElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEGaussianBlurElement). extension type SVGFEGaussianBlurElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEGaussianBlurElement] using the tag 'feGaussianBlur'. @@ -415,6 +510,11 @@ extension type SVGFEGaussianBlurElement._(JSObject _) } /// The **`SVGFEImageElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEImageElement). extension type SVGFEImageElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEImageElement] using the tag 'feImage'. SVGFEImageElement() @@ -434,6 +534,11 @@ extension type SVGFEImageElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGFEMergeElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEMergeElement). extension type SVGFEMergeElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEMergeElement] using the tag 'feMerge'. SVGFEMergeElement() @@ -450,6 +555,11 @@ extension type SVGFEMergeElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGFEMergeNodeElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEMergeNodeElement). extension type SVGFEMergeNodeElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEMergeNodeElement] using the tag 'feMergeNode'. @@ -463,6 +573,11 @@ extension type SVGFEMergeNodeElement._(JSObject _) } /// The **`SVGFEMorphologyElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEMorphologyElement). extension type SVGFEMorphologyElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEMorphologyElement] using the tag 'feMorphology'. @@ -487,6 +602,11 @@ extension type SVGFEMorphologyElement._(JSObject _) } /// The **`SVGFEOffsetElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFEOffsetElement). extension type SVGFEOffsetElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFEOffsetElement] using the tag 'feOffset'. @@ -508,6 +628,11 @@ extension type SVGFEOffsetElement._(JSObject _) /// The **`SVGFESpecularLightingElement`** interface corresponds to the /// element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFESpecularLightingElement). extension type SVGFESpecularLightingElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFESpecularLightingElement] using the tag @@ -532,6 +657,11 @@ extension type SVGFESpecularLightingElement._(JSObject _) } /// The **`SVGFETileElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFETileElement). extension type SVGFETileElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFETileElement] using the tag 'feTile'. SVGFETileElement() @@ -549,6 +679,11 @@ extension type SVGFETileElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGFETurbulenceElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGFETurbulenceElement). extension type SVGFETurbulenceElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGFETurbulenceElement] using the tag 'feTurbulence'. diff --git a/lib/src/dom/fs.dart b/lib/src/dom/fs.dart index 920aaa3f..7c1ff0a5 100644 --- a/lib/src/dom/fs.dart +++ b/lib/src/dom/fs.dart @@ -26,6 +26,11 @@ typedef WriteCommandType = String; /// the same entry. For the most part you do not work with `FileSystemHandle` /// directly but rather its child interfaces [FileSystemFileHandle] and /// [FileSystemDirectoryHandle]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle). extension type FileSystemHandle._(JSObject _) implements JSObject { /// The **`isSameEntry()`** method of the /// [FileSystemHandle] interface compares two [FileSystemHandle] to see if the @@ -51,6 +56,11 @@ extension type FileSystemCreateWritableOptions._(JSObject _) /// open. The [FileSystemHandle.queryPermission] method of the /// [FileSystemHandle] interface can be used to verify permission state before /// accessing a file. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemFileHandle). extension type FileSystemFileHandle._(JSObject _) implements FileSystemHandle, JSObject { /// The **`getFile()`** method of the @@ -117,6 +127,11 @@ extension type FileSystemRemoveOptions._(JSObject _) implements JSObject { /// The interface can be accessed via the [window.showDirectoryPicker], /// [StorageManager.getDirectory], [DataTransferItem.getAsFileSystemHandle], and /// [FileSystemDirectoryHandle.getDirectoryHandle] methods. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemDirectoryHandle). extension type FileSystemDirectoryHandle._(JSObject _) implements FileSystemHandle, JSObject { /// The **`getFileHandle()`** method of the @@ -175,6 +190,11 @@ extension type WriteParams._(JSObject _) implements JSObject { /// a [WritableStream] object with additional convenience methods, which /// operates on a single file on disk. The interface is accessed through the /// [FileSystemFileHandle.createWritable] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream). extension type FileSystemWritableFileStream._(JSObject _) implements WritableStream, JSObject { /// The **`write()`** method of the [FileSystemWritableFileStream] interface @@ -243,6 +263,11 @@ extension type FileSystemReadWriteOptions._(JSObject _) implements JSObject { /// > asynchronous methods, and older versions of some browsers implement them /// > in this way. However, all current browsers that support these methods /// > implement them as synchronous methods. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemSyncAccessHandle). extension type FileSystemSyncAccessHandle._(JSObject _) implements JSObject { /// The **`read()`** method of the /// [FileSystemSyncAccessHandle] interface reads the content of the file diff --git a/lib/src/dom/gamepad.dart b/lib/src/dom/gamepad.dart index f0d4411d..73d472bf 100644 --- a/lib/src/dom/gamepad.dart +++ b/lib/src/dom/gamepad.dart @@ -29,6 +29,11 @@ typedef GamepadHapticEffectType = String; /// property of the [Window.gamepadconnected_event] and /// [Window.gamepaddisconnected_event] events, or by grabbing any position in /// the array returned by the [Navigator.getGamepads] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Gamepad). extension type Gamepad._(JSObject _) implements JSObject { external String get id; external int get index; @@ -46,6 +51,11 @@ extension type Gamepad._(JSObject _) implements JSObject { /// /// A `GamepadButton` object is returned by querying any value of the array /// returned by the `buttons` property of the [Gamepad] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/GamepadButton). extension type GamepadButton._(JSObject _) implements JSObject { external bool get pressed; external bool get touched; @@ -58,6 +68,11 @@ extension type GamepadButton._(JSObject _) implements JSObject { /// the user (if available), most commonly vibration hardware. /// /// This interface is accessible through the [Gamepad.hapticActuators] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/GamepadHapticActuator). extension type GamepadHapticActuator._(JSObject _) implements JSObject { /// The **`playEffect()`** method of the [GamepadHapticActuator] interface /// makes the hardware play a specific vibration pattern. @@ -90,6 +105,11 @@ extension type GamepadEffectParameters._(JSObject _) implements JSObject { /// gamepads connected to the system, which is what the gamepad events /// [Window.gamepadconnected_event] and [Window.gamepaddisconnected_event] are /// fired in response to. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/GamepadEvent). extension type GamepadEvent._(JSObject _) implements Event, JSObject { external factory GamepadEvent( String type, diff --git a/lib/src/dom/geolocation.dart b/lib/src/dom/geolocation.dart index e18cd758..b46a5216 100644 --- a/lib/src/dom/geolocation.dart +++ b/lib/src/dom/geolocation.dart @@ -30,6 +30,11 @@ typedef PositionErrorCallback = JSFunction; /// > information, the user is notified and asked to grant permission. Be aware /// > that each browser has its own policies and methods for requesting this /// > permission. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation). extension type Geolocation._(JSObject _) implements JSObject { /// The **`getCurrentPosition()`** method of the [Geolocation] interface is /// used to get the current position of the device. @@ -73,6 +78,11 @@ extension type PositionOptions._(JSObject _) implements JSObject { /// concerned device at a given time. The position, represented by a /// [GeolocationCoordinates] object, comprehends the 2D position of the device, /// on a spheroid representing the Earth, but also its altitude and its speed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationPosition). extension type GeolocationPosition._(JSObject _) implements JSObject { external GeolocationCoordinates get coords; external EpochTimeStamp get timestamp; @@ -83,6 +93,11 @@ extension type GeolocationPosition._(JSObject _) implements JSObject { /// properties are calculated. /// The geographic position information is provided in terms of World Geodetic /// System coordinates (WGS84). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates). extension type GeolocationCoordinates._(JSObject _) implements JSObject { external num get accuracy; external num get latitude; @@ -95,6 +110,11 @@ extension type GeolocationCoordinates._(JSObject _) implements JSObject { /// The **`GeolocationPositionError`** interface represents the reason of an /// error occurring when using the geolocating device. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationPositionError). extension type GeolocationPositionError._(JSObject _) implements JSObject { external static int get PERMISSION_DENIED; external static int get POSITION_UNAVAILABLE; diff --git a/lib/src/dom/geometry.dart b/lib/src/dom/geometry.dart index f0444477..6f5f12bd 100644 --- a/lib/src/dom/geometry.dart +++ b/lib/src/dom/geometry.dart @@ -38,6 +38,11 @@ import 'dart:js_interop'; /// ```js /// const point = DOMPointReadOnly.fromPoint({ x: 100, y: 100, z: 50, w: 1.0 }); /// ``` +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMPointReadOnly). extension type DOMPointReadOnly._(JSObject _) implements JSObject { external factory DOMPointReadOnly([ num x, @@ -68,6 +73,11 @@ extension type DOMPointReadOnly._(JSObject _) implements JSObject { /// the origin, a positive `y` component is downward from the origin, and a /// positive `z` component extends outward from the screen (in other words, /// toward the user). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMPoint). extension type DOMPoint._(JSObject _) implements DOMPointReadOnly, JSObject { external factory DOMPoint([ num x, @@ -106,6 +116,11 @@ extension type DOMPointInit._(JSObject _) implements JSObject { /// The **`DOMRectReadOnly`** interface specifies the standard properties (also /// used by [DOMRect]) to define a rectangle whose properties are immutable. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMRectReadOnly). extension type DOMRectReadOnly._(JSObject _) implements JSObject { external factory DOMRectReadOnly([ num x, @@ -134,6 +149,11 @@ extension type DOMRectReadOnly._(JSObject _) implements JSObject { /// objects. /// /// It inherits from its parent, [DOMRectReadOnly]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMRect). extension type DOMRect._(JSObject _) implements DOMRectReadOnly, JSObject { external factory DOMRect([ num x, @@ -179,6 +199,11 @@ extension type DOMRectList._(JSObject _) implements JSObject { /// accurate information even when arbitrary 2D or 3D transforms are present. It /// has a handy `bounds` attribute returning a `DOMRectReadOnly` for those cases /// where you just want an axis-aligned bounding rectangle. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMQuad). extension type DOMQuad._(JSObject _) implements JSObject { external factory DOMQuad([ DOMPointInit p1, @@ -223,6 +248,11 @@ extension type DOMQuadInit._(JSObject _) implements JSObject { /// This interface should be available inside /// [web workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API), /// though some implementations doesn't allow it yet. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMMatrixReadOnly). extension type DOMMatrixReadOnly._(JSObject _) implements JSObject { external factory DOMMatrixReadOnly([JSAny init]); @@ -323,6 +353,11 @@ extension type DOMMatrixReadOnly._(JSObject _) implements JSObject { /// This interface should be available inside /// [web workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API), /// though some implementations don't allow it yet. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMMatrix). extension type DOMMatrix._(JSObject _) implements DOMMatrixReadOnly, JSObject { external factory DOMMatrix([JSAny init]); diff --git a/lib/src/dom/hr_time.dart b/lib/src/dom/hr_time.dart index b274d31e..91cd447c 100644 --- a/lib/src/dom/hr_time.dart +++ b/lib/src/dom/hr_time.dart @@ -31,6 +31,11 @@ typedef EpochTimeStamp = int; /// cannot see it in a worker thread, and vice versa. See /// [`self.performance`](/en-US/docs/Web/API/performance_property) for which /// APIs are available in window and worker contexts. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Performance). extension type Performance._(JSObject _) implements EventTarget, JSObject { /// The **`performance.now()`** method returns a high resolution timestamp in /// milliseconds. It represents the time elapsed since diff --git a/lib/src/dom/html.dart b/lib/src/dom/html.dart index 1cfec9f4..d4b50d42 100644 --- a/lib/src/dom/html.dart +++ b/lib/src/dom/html.dart @@ -111,6 +111,11 @@ typedef WorkerType = String; /// are many subtle behavior differences — for example, `HTMLAllCollection` can /// be called as a function, and its `item()` method can be called with a string /// representing an element's `id` or `name` attribute. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAllCollection). extension type HTMLAllCollection._(JSObject _) implements JSObject { /// The **`namedItem()`** method of the [HTMLAllCollection] interface returns /// the first [Element] in the collection whose `id` or `name` attribute @@ -130,6 +135,11 @@ extension type HTMLAllCollection._(JSObject _) implements JSObject { /// /// This interface replaces one method from [HTMLCollection], on which it is /// based. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormControlsCollection). extension type HTMLFormControlsCollection._(JSObject _) implements HTMLCollection, JSObject { /// The **`HTMLFormControlsCollection.namedItem()`** method returns @@ -147,6 +157,11 @@ extension type HTMLFormControlsCollection._(JSObject _) /// The **`RadioNodeList`** interface represents a collection of elements in a /// `form` or a `fieldset` element, returned by a call to /// [HTMLFormControlsCollection.namedItem]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RadioNodeList). extension type RadioNodeList._(JSObject _) implements NodeList, JSObject { external set value(String value); external String get value; @@ -158,6 +173,11 @@ extension type RadioNodeList._(JSObject _) implements NodeList, JSObject { /// as optionally altering its items. This object is returned only by the /// `options` property of /// [select](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOptionsCollection). extension type HTMLOptionsCollection._(JSObject _) implements HTMLCollection, JSObject { external void add( @@ -182,6 +202,11 @@ extension type HTMLOptionsCollection._(JSObject _) /// - [IDBDatabase.objectStoreNames] /// - [IDBObjectStore.indexNames] /// - [Location.ancestorOrigins] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMStringList). extension type DOMStringList._(JSObject _) implements JSObject { /// The **`item()`** method returns a string from a /// [`DOMStringList`](https://developer.mozilla.org/en-US/docs/Web/API/DOMStringList) @@ -198,6 +223,11 @@ extension type DOMStringList._(JSObject _) implements JSObject { /// [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) element. Some /// elements directly implement this interface, while others implement it via an /// interface that inherits it. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement). extension type HTMLElement._(JSObject _) implements Element, JSObject { /// Creates an [HTMLElement] using the tag 'article'. HTMLElement.article() : _ = document.createElement('article'); @@ -687,6 +717,11 @@ extension type HTMLElement._(JSObject _) implements Element, JSObject { /// The **`HTMLUnknownElement`** interface represents an invalid HTML element /// and derives from the [HTMLElement] interface, but without implementing any /// additional properties or methods. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLUnknownElement). extension type HTMLUnknownElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLUnknownElement] using the tag 'applet'. @@ -716,6 +751,11 @@ extension type HTMLUnknownElement._(JSObject _) /// The **`DOMStringMap`** interface is used for the [HTMLElement.dataset] /// attribute, to represent data for custom attributes added to elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMStringMap). extension type DOMStringMap._(JSObject _) implements JSObject {} /// The **`HTMLHtmlElement`** interface serves as the root node for a given HTML @@ -724,6 +764,11 @@ extension type DOMStringMap._(JSObject _) implements JSObject {} /// /// You can retrieve the `HTMLHtmlElement` object for a given document by /// reading the value of the [document.documentElement] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHtmlElement). extension type HTMLHtmlElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLHtmlElement] using the tag 'html'. HTMLHtmlElement() : _ = document.createElement('html'); @@ -735,6 +780,11 @@ extension type HTMLHtmlElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLHeadElement`** interface contains the descriptive information, or /// metadata, for a document. This object inherits all of the properties and /// methods described in the [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHeadElement). extension type HTMLHeadElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLHeadElement] using the tag 'head'. HTMLHeadElement() : _ = document.createElement('head'); @@ -743,6 +793,11 @@ extension type HTMLHeadElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLTitleElement`** interface is implemented by a document's `title`. /// This element inherits all of the properties and methods of the [HTMLElement] /// interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTitleElement). extension type HTMLTitleElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTitleElement] using the tag 'title'. HTMLTitleElement() : _ = document.createElement('title'); @@ -754,6 +809,11 @@ extension type HTMLTitleElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLBaseElement`** interface contains the base URI for a document. /// This object inherits all of the properties and methods as described in the /// [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLBaseElement). extension type HTMLBaseElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLBaseElement] using the tag 'base'. HTMLBaseElement() : _ = document.createElement('base'); @@ -772,6 +832,11 @@ extension type HTMLBaseElement._(JSObject _) implements HTMLElement, JSObject { /// [`HTMLAnchorElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAnchorElement)). /// This object inherits all of the properties and methods of the [HTMLElement] /// interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLinkElement). extension type HTMLLinkElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLLinkElement] using the tag 'link'. HTMLLinkElement() : _ = document.createElement('link'); @@ -819,6 +884,11 @@ extension type HTMLLinkElement._(JSObject _) implements HTMLElement, JSObject { /// elements. /// This interface inherits all of the properties and methods described in the /// [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMetaElement). extension type HTMLMetaElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLMetaElement] using the tag 'meta'. HTMLMetaElement() : _ = document.createElement('meta'); @@ -843,6 +913,11 @@ extension type HTMLMetaElement._(JSObject _) implements HTMLElement, JSObject { /// [Using dynamic styling information](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Object_Model/Using_dynamic_styling_information) /// for an overview of the objects used to manipulate specified CSS properties /// using the DOM. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLStyleElement). extension type HTMLStyleElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLStyleElement] using the tag 'style'. HTMLStyleElement() : _ = document.createElement('style'); @@ -860,6 +935,11 @@ extension type HTMLStyleElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLBodyElement`** interface provides special properties (beyond /// those inherited from the regular [HTMLElement] interface) for manipulating /// `body` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLBodyElement). extension type HTMLBodyElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLBodyElement] using the tag 'body'. HTMLBodyElement() : _ = document.createElement('body'); @@ -920,6 +1000,11 @@ extension type HTMLBodyElement._(JSObject _) implements HTMLElement, JSObject { /// elements, [`

` through /// `

`](/en-US/docs/Web/HTML/Element/Heading_Elements). It inherits methods /// and properties from the [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHeadingElement). extension type HTMLHeadingElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLHeadingElement] using the tag 'h1'. @@ -947,6 +1032,11 @@ extension type HTMLHeadingElement._(JSObject _) /// The **`HTMLParagraphElement`** interface provides special properties (beyond /// those of the regular [HTMLElement] object interface it inherits) for /// manipulating `p` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLParagraphElement). extension type HTMLParagraphElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLParagraphElement] using the tag 'p'. @@ -959,6 +1049,11 @@ extension type HTMLParagraphElement._(JSObject _) /// The **`HTMLHRElement`** interface provides special properties (beyond those /// of the [HTMLElement] interface it also has available to it by inheritance) /// for manipulating `hr` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHRElement). extension type HTMLHRElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLHRElement] using the tag 'hr'. HTMLHRElement() : _ = document.createElement('hr'); @@ -978,6 +1073,11 @@ extension type HTMLHRElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLPreElement`** interface exposes specific properties and methods /// (beyond those of the [HTMLElement] interface it also has available to it by /// inheritance) for manipulating a block of preformatted text (`pre`). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLPreElement). extension type HTMLPreElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLPreElement] using the tag 'pre'. HTMLPreElement.pre() : _ = document.createElement('pre'); @@ -996,6 +1096,11 @@ extension type HTMLPreElement._(JSObject _) implements HTMLElement, JSObject { /// (beyond the regular [HTMLElement] interface it also has available to it by /// inheritance) for manipulating quoting elements, like `blockquote` and `q`, /// but not the `cite` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLQuoteElement). extension type HTMLQuoteElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLQuoteElement] using the tag 'blockquote'. HTMLQuoteElement.blockquote() : _ = document.createElement('blockquote'); @@ -1010,6 +1115,11 @@ extension type HTMLQuoteElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLOListElement`** interface provides special properties (beyond /// those defined on the regular [HTMLElement] interface it also has available /// to it by inheritance) for manipulating ordered list elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOListElement). extension type HTMLOListElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLOListElement] using the tag 'ol'. HTMLOListElement() : _ = document.createElement('ol'); @@ -1027,6 +1137,11 @@ extension type HTMLOListElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLUListElement`** interface provides special properties (beyond /// those defined on the regular [HTMLElement] interface it also has available /// to it by inheritance) for manipulating unordered list (`ul`) elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLUListElement). extension type HTMLUListElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLUListElement] using the tag 'ul'. HTMLUListElement() : _ = document.createElement('ul'); @@ -1041,6 +1156,11 @@ extension type HTMLUListElement._(JSObject _) implements HTMLElement, JSObject { /// those inherited from the [HTMLElement] interface) for manipulating a `menu` /// element. /// `` is a semantic alternative to the `ul` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMenuElement). extension type HTMLMenuElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLMenuElement] using the tag 'menu'. HTMLMenuElement() : _ = document.createElement('menu'); @@ -1052,6 +1172,11 @@ extension type HTMLMenuElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLLIElement`** interface exposes specific properties and methods /// (beyond those defined by regular [HTMLElement] interface it also has /// available to it by inheritance) for manipulating list elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLIElement). extension type HTMLLIElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLLIElement] using the tag 'li'. HTMLLIElement() : _ = document.createElement('li'); @@ -1065,6 +1190,11 @@ extension type HTMLLIElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLDListElement`** interface provides special properties (beyond /// those of the regular [HTMLElement] interface it also has available to it by /// inheritance) for manipulating definition list (`dl`) elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDListElement). extension type HTMLDListElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLDListElement] using the tag 'dl'. HTMLDListElement() : _ = document.createElement('dl'); @@ -1076,6 +1206,11 @@ extension type HTMLDListElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLDivElement`** interface provides special properties (beyond the /// regular [HTMLElement] interface it also has available to it by inheritance) /// for manipulating `div` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDivElement). extension type HTMLDivElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLDivElement] using the tag 'div'. HTMLDivElement() : _ = document.createElement('div'); @@ -1091,6 +1226,11 @@ extension type HTMLDivElement._(JSObject _) implements HTMLElement, JSObject { /// [``](/en-US/docs/Web/HTML/Element/a) element; not to be confused with /// [``](/en-US/docs/Web/HTML/Element/link), which is represented by /// [`HTMLLinkElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLinkElement). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAnchorElement). extension type HTMLAnchorElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLAnchorElement] using the tag 'a'. @@ -1149,6 +1289,11 @@ extension type HTMLAnchorElement._(JSObject _) /// The **`HTMLDataElement`** interface provides special properties (beyond the /// regular [HTMLElement] interface it also has available to it by inheritance) /// for manipulating `data` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDataElement). extension type HTMLDataElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLDataElement] using the tag 'data'. HTMLDataElement() : _ = document.createElement('data'); @@ -1160,6 +1305,11 @@ extension type HTMLDataElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLTimeElement`** interface provides special properties (beyond the /// regular [HTMLElement] interface it also has available to it by inheritance) /// for manipulating `time` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTimeElement). extension type HTMLTimeElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTimeElement] using the tag 'time'. HTMLTimeElement() : _ = document.createElement('time'); @@ -1171,6 +1321,11 @@ extension type HTMLTimeElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLSpanElement`** interface represents a `span` element and derives /// from the [HTMLElement] interface, but without implementing any additional /// properties or methods. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSpanElement). extension type HTMLSpanElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLSpanElement] using the tag 'span'. HTMLSpanElement() : _ = document.createElement('span'); @@ -1178,6 +1333,11 @@ extension type HTMLSpanElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLBRElement`** interface represents an HTML line break element /// (`br`). It inherits from [HTMLElement]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLBRElement). extension type HTMLBRElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLBRElement] using the tag 'br'. HTMLBRElement() : _ = document.createElement('br'); @@ -1190,6 +1350,11 @@ extension type HTMLBRElement._(JSObject _) implements HTMLElement, JSObject { /// regular methods and properties available through the [HTMLElement] interface /// they also have available to them by inheritance) for manipulating /// modification elements, that is `del` and `ins`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLModElement). extension type HTMLModElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLModElement] using the tag 'ins'. HTMLModElement.ins() : _ = document.createElement('ins'); @@ -1205,6 +1370,11 @@ extension type HTMLModElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLPictureElement`** interface represents a `picture` HTML element. /// It doesn't implement specific properties or methods. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLPictureElement). extension type HTMLPictureElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLPictureElement] using the tag 'picture'. @@ -1214,6 +1384,11 @@ extension type HTMLPictureElement._(JSObject _) /// The **`HTMLSourceElement`** interface provides special properties (beyond /// the regular [HTMLElement] object interface it also has available to it by /// inheritance) for manipulating `source` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSourceElement). extension type HTMLSourceElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLSourceElement] using the tag 'source'. @@ -1237,6 +1412,11 @@ extension type HTMLSourceElement._(JSObject _) /// The **`HTMLImageElement`** interface represents an HTML `img` element, /// providing the properties and methods used to manipulate image elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement). extension type HTMLImageElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLImageElement] using the tag 'img'. HTMLImageElement() : _ = document.createElement('img'); @@ -1307,6 +1487,11 @@ extension type HTMLImageElement._(JSObject _) implements HTMLElement, JSObject { /// methods (beyond those of the [HTMLElement] interface it also has available /// to it by inheritance) for manipulating the layout and presentation of inline /// frame elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLIFrameElement). extension type HTMLIFrameElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLIFrameElement] using the tag 'iframe'. @@ -1355,6 +1540,11 @@ extension type HTMLIFrameElement._(JSObject _) /// > **Note:** This topic describes the `HTMLEmbedElement` interface as defined /// > in the standard. It does not address earlier, non-standardized version of /// > the interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLEmbedElement). extension type HTMLEmbedElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLEmbedElement] using the tag 'embed'. HTMLEmbedElement() : _ = document.createElement('embed'); @@ -1378,6 +1568,11 @@ extension type HTMLEmbedElement._(JSObject _) implements HTMLElement, JSObject { /// methods (beyond those on the [HTMLElement] interface it also has available /// to it by inheritance) for manipulating the layout and presentation of /// `object` element, representing external resources. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement). extension type HTMLObjectElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLObjectElement] using the tag 'object'. @@ -1447,6 +1642,11 @@ extension type HTMLObjectElement._(JSObject _) /// in a single format that all the relevant browsers supports, or provide /// multiple video sources in enough different formats that all the browsers you /// need to support are covered. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement). extension type HTMLVideoElement._(JSObject _) implements HTMLMediaElement, JSObject { /// Creates an [HTMLVideoElement] using the tag 'video'. @@ -1476,6 +1676,11 @@ extension type HTMLVideoElement._(JSObject _) /// /// This element is based on, and inherits properties and methods from, the /// [HTMLMediaElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAudioElement). extension type HTMLAudioElement._(JSObject _) implements HTMLMediaElement, JSObject { /// Creates an [HTMLAudioElement] using the tag 'audio'. @@ -1486,6 +1691,11 @@ extension type HTMLAudioElement._(JSObject _) /// the . This element can be used as a child of either `audio` or `video` to /// specify a text track containing information such as closed captions or /// subtitles. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTrackElement). extension type HTMLTrackElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTrackElement] using the tag 'track'. HTMLTrackElement() : _ = document.createElement('track'); @@ -1516,6 +1726,11 @@ extension type HTMLTrackElement._(JSObject _) implements HTMLElement, JSObject { /// /// The [HTMLVideoElement] and [HTMLAudioElement] elements both inherit this /// interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement). extension type HTMLMediaElement._(JSObject _) implements HTMLElement, JSObject { external static int get NETWORK_EMPTY; external static int get NETWORK_IDLE; @@ -1641,6 +1856,11 @@ extension type HTMLMediaElement._(JSObject _) implements HTMLElement, JSObject { /// A `MediaError` object describes the error in general terms using a numeric /// `code` categorizing the kind of error, and a `message`, which provides /// specific diagnostics about what went wrong. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaError). extension type MediaError._(JSObject _) implements JSObject { external static int get MEDIA_ERR_ABORTED; external static int get MEDIA_ERR_NETWORK; @@ -1656,6 +1876,11 @@ extension type MediaError._(JSObject _) implements JSObject { /// /// Retrieve an instance of this object with [HTMLMediaElement.audioTracks]. The /// individual tracks can be accessed using array syntax. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioTrackList). extension type AudioTrackList._(JSObject _) implements EventTarget, JSObject { /// The **[AudioTrackList]** method /// **`getTrackById()`** returns the first @@ -1677,6 +1902,11 @@ extension type AudioTrackList._(JSObject _) implements EventTarget, JSObject { /// /// The most common use for accessing an `AudioTrack` object is to toggle its /// [AudioTrack.enabled] property in order to mute and unmute the track. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack). extension type AudioTrack._(JSObject _) implements JSObject { external String get id; external String get kind; @@ -1694,6 +1924,11 @@ extension type AudioTrack._(JSObject _) implements JSObject { /// Retrieve an instance of this object with [HTMLMediaElement.videoTracks]. The /// individual tracks can be accessed using array syntax or functions such as /// `forEach()` for example. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/VideoTrackList). extension type VideoTrackList._(JSObject _) implements EventTarget, JSObject { /// The **[VideoTrackList]** method /// **`getTrackById()`** returns the first @@ -1719,6 +1954,11 @@ extension type VideoTrackList._(JSObject _) implements EventTarget, JSObject { /// The most common use for accessing a `VideoTrack` object is to toggle its /// [VideoTrack.selected] property in order to make it the active video track /// for its `video` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/VideoTrack). extension type VideoTrack._(JSObject _) implements JSObject { external String get id; external String get kind; @@ -1745,6 +1985,11 @@ extension type VideoTrack._(JSObject _) implements JSObject { /// - the /// `media.textTracks`.[`getTrackById()`](/en-US/docs/Web/API/TextTrackList/getTrackById) /// method +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextTrackList). extension type TextTrackList._(JSObject _) implements EventTarget, JSObject { /// The **[TextTrackList]** method /// **`getTrackById()`** returns the first @@ -1766,6 +2011,11 @@ extension type TextTrackList._(JSObject _) implements EventTarget, JSObject { /// The `TextTrack` interface—part of the API for handling WebVTT (text tracks /// on media presentations)—describes and controls the text track associated /// with a particular `track` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextTrack). extension type TextTrack._(JSObject _) implements EventTarget, JSObject { /// The **`addCue()`** method of the [TextTrack] interface adds a new cue to /// the list of cues. @@ -1793,6 +2043,11 @@ extension type TextTrack._(JSObject _) implements EventTarget, JSObject { /// /// This interface has no constructor. Retrieve an instance of this object with /// [TextTrack.cues] which returns all of the cues in a [TextTrack] object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextTrackCueList). extension type TextTrackCueList._(JSObject _) implements JSObject { /// The **`getCueById()`** method of the [TextTrackCueList] interface returns /// the first [VTTCue] in the list represented by the `TextTrackCueList` @@ -1808,6 +2063,11 @@ extension type TextTrackCueList._(JSObject _) implements JSObject { /// the start time (the time at which the text will be displayed) and the end /// time (the time at which it will be removed from the display), as well as /// other information. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextTrackCue). extension type TextTrackCue._(JSObject _) implements EventTarget, JSObject { external TextTrack? get track; external set id(String value); @@ -1833,6 +2093,11 @@ extension type TextTrackCue._(JSObject _) implements EventTarget, JSObject { /// a starting time offset and an ending time offset. You reference each time /// range by using the `start()` and `end()` methods, passing the index number /// of the time range you want to retrieve. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TimeRanges). extension type TimeRanges._(JSObject _) implements JSObject { /// The **`start()`** method of the [TimeRanges] interface returns the time /// offset at which a specified time range begins. @@ -1861,6 +2126,11 @@ extension type TimeRanges._(JSObject _) implements JSObject { /// specified in [HTMLMediaElement.audioTracks] /// - Events affecting text tracks are sent to the [TextTrackList] object /// indicated by [HTMLMediaElement.textTracks]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TrackEvent). extension type TrackEvent._(JSObject _) implements Event, JSObject { external factory TrackEvent( String type, [ @@ -1885,6 +2155,11 @@ extension type TrackEventInit._(JSObject _) implements EventInit, JSObject { /// (beyond those of the regular object [HTMLElement] interface it also has /// available to it by inheritance) for manipulating the layout and presentation /// of map elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMapElement). extension type HTMLMapElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLMapElement] using the tag 'map'. HTMLMapElement() : _ = document.createElement('map'); @@ -1898,6 +2173,11 @@ extension type HTMLMapElement._(JSObject _) implements HTMLElement, JSObject { /// (beyond those of the regular object [HTMLElement] interface it also has /// available to it by inheritance) for manipulating the layout and presentation /// of `area` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAreaElement). extension type HTMLAreaElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLAreaElement] using the tag 'area'. HTMLAreaElement() : _ = document.createElement('area'); @@ -1948,6 +2228,11 @@ extension type HTMLAreaElement._(JSObject _) implements HTMLElement, JSObject { /// (beyond the regular [HTMLElement] object interface it also has available to /// it by inheritance) for manipulating the layout and presentation of tables in /// an HTML document. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableElement). extension type HTMLTableElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTableElement] using the tag 'table'. HTMLTableElement() : _ = document.createElement('table'); @@ -2068,6 +2353,11 @@ extension type HTMLTableElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLTableCaptionElement`** interface provides special properties /// (beyond the regular [HTMLElement] interface it also has available to it by /// inheritance) for manipulating table `caption` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableCaptionElement). extension type HTMLTableCaptionElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTableCaptionElement] using the tag 'caption'. @@ -2079,6 +2369,11 @@ extension type HTMLTableCaptionElement._(JSObject _) /// The **`HTMLTableColElement`** interface provides properties for manipulating /// single or grouped table column elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableColElement). extension type HTMLTableColElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTableColElement] using the tag 'colgroup'. @@ -2106,6 +2401,11 @@ extension type HTMLTableColElement._(JSObject _) /// inheritance) for manipulating the layout and presentation of sections, that /// is headers, footers and bodies (`thead`, `tfoot`, and `tbody`, respectively) /// in an HTML table. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableSectionElement). extension type HTMLTableSectionElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTableSectionElement] using the tag 'tbody'. @@ -2134,6 +2434,11 @@ extension type HTMLTableSectionElement._(JSObject _) /// methods (beyond the [HTMLElement] interface it also has available to it by /// inheritance) for manipulating the layout and presentation of rows in an HTML /// table. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableRowElement). extension type HTMLTableRowElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTableRowElement] using the tag 'tr'. @@ -2173,6 +2478,11 @@ extension type HTMLTableRowElement._(JSObject _) /// it by inheritance) for manipulating the layout and presentation of table /// cells, either header cells (`th`)) or data cells (`td`), in an HTML /// document. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableCellElement). extension type HTMLTableCellElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTableCellElement] using the tag 'td'. @@ -2215,6 +2525,11 @@ extension type HTMLTableCellElement._(JSObject _) /// The **`HTMLFormElement`** interface represents a `form` element in the DOM. /// It allows access to—and, in some cases, modification of—aspects of the form, /// as well as access to its component elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement). extension type HTMLFormElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLFormElement] using the tag 'form'. HTMLFormElement() : _ = document.createElement('form'); @@ -2303,6 +2618,11 @@ extension type HTMLFormElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLLabelElement`** interface gives access to properties specific to /// `label` elements. It inherits methods and properties from the base /// [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement). extension type HTMLLabelElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLLabelElement] using the tag 'label'. HTMLLabelElement() : _ = document.createElement('label'); @@ -2315,6 +2635,11 @@ extension type HTMLLabelElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLInputElement`** interface provides special properties and methods /// for manipulating the options, layout, and presentation of `input` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement). extension type HTMLInputElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLInputElement] using the tag 'input'. HTMLInputElement() : _ = document.createElement('input'); @@ -2728,6 +3053,11 @@ extension type HTMLInputElement._(JSObject _) implements HTMLElement, JSObject { /// The **`HTMLButtonElement`** interface provides properties and methods /// (beyond the regular [HTMLElement] interface it also has available to it by /// inheritance) for manipulating `button` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLButtonElement). extension type HTMLButtonElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLButtonElement] using the tag 'button'. @@ -2768,6 +3098,11 @@ extension type HTMLButtonElement._(JSObject _) /// The **`HTMLSelectElement`** interface represents a `select` HTML Element. /// These elements also share all of the properties and methods of other HTML /// elements via the [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement). extension type HTMLSelectElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLSelectElement] using the tag 'select'. @@ -2861,6 +3196,11 @@ extension type HTMLSelectElement._(JSObject _) /// The **`HTMLDataListElement`** interface provides special properties (beyond /// the [HTMLElement] object interface it also has available to it by /// inheritance) to manipulate `datalist` elements and their content. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDataListElement). extension type HTMLDataListElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLDataListElement] using the tag 'datalist'. @@ -2873,6 +3213,11 @@ extension type HTMLDataListElement._(JSObject _) /// methods (beyond the regular [HTMLElement] object interface they also have /// available to them by inheritance) for manipulating the layout and /// presentation of `optgroup` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOptGroupElement). extension type HTMLOptGroupElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLOptGroupElement] using the tag 'optgroup'. @@ -2886,6 +3231,11 @@ extension type HTMLOptGroupElement._(JSObject _) /// The **`HTMLOptionElement`** interface represents `option` elements and /// inherits all properties and methods of the [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOptionElement). extension type HTMLOptionElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLOptionElement] using the tag 'option'. @@ -2909,6 +3259,11 @@ extension type HTMLOptionElement._(JSObject _) /// The **`HTMLTextAreaElement`** interface provides special properties and /// methods for manipulating the layout and presentation of `textarea` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement). extension type HTMLTextAreaElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTextAreaElement] using the tag 'textarea'. @@ -2975,6 +3330,11 @@ extension type HTMLTextAreaElement._(JSObject _) /// The **`HTMLOutputElement`** interface provides properties and methods /// (beyond those inherited from [HTMLElement]) for manipulating the layout and /// presentation of `output` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOutputElement). extension type HTMLOutputElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLOutputElement] using the tag 'output'. @@ -3002,6 +3362,11 @@ extension type HTMLOutputElement._(JSObject _) /// methods (beyond the regular [HTMLElement] interface it also has available to /// it by inheritance) for manipulating the layout and presentation of /// `progress` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLProgressElement). extension type HTMLProgressElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLProgressElement] using the tag 'progress'. @@ -3019,6 +3384,11 @@ extension type HTMLProgressElement._(JSObject _) /// provides special properties and methods (beyond the [HTMLElement] object /// interface they also have available to them by inheritance) for manipulating /// the layout and presentation of `meter` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMeterElement). extension type HTMLMeterElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLMeterElement] using the tag 'meter'. HTMLMeterElement() : _ = document.createElement('meter'); @@ -3042,6 +3412,11 @@ extension type HTMLMeterElement._(JSObject _) implements HTMLElement, JSObject { /// methods (beyond the regular [HTMLElement] interface it also has available to /// it by inheritance) for manipulating the layout and presentation of /// `fieldset` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFieldSetElement). extension type HTMLFieldSetElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLFieldSetElement] using the tag 'fieldset'. @@ -3065,6 +3440,11 @@ extension type HTMLFieldSetElement._(JSObject _) /// The **`HTMLLegendElement`** is an interface allowing to access properties of /// the `legend` elements. It inherits properties and methods from the /// [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLegendElement). extension type HTMLLegendElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLLegendElement] using the tag 'legend'. @@ -3078,6 +3458,11 @@ extension type HTMLLegendElement._(JSObject _) /// The **`ValidityState`** interface represents the _validity states_ that an /// element can be in, with respect to constraint validation. Together, they /// help explain why an element's value fails to validate, if it's not valid. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ValidityState). extension type ValidityState._(JSObject _) implements JSObject { external bool get valueMissing; external bool get typeMismatch; @@ -3095,6 +3480,11 @@ extension type ValidityState._(JSObject _) implements JSObject { /// The **`SubmitEvent`** interface defines the object used to represent an /// form's [HTMLFormElement.submit_event] event. This event is fired at the /// `form` when the form's submit action is invoked. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SubmitEvent). extension type SubmitEvent._(JSObject _) implements Event, JSObject { external factory SubmitEvent( String type, [ @@ -3126,6 +3516,11 @@ extension type SubmitEventInit._(JSObject _) implements EventInit, JSObject { /// `formdata` event firing, rather than needing to put it together yourself /// when you wish to submit form data via a method like [fetch] (see /// [Using FormData objects](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest_API/Using_FormData_Objects)). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FormDataEvent). extension type FormDataEvent._(JSObject _) implements Event, JSObject { external factory FormDataEvent( String type, @@ -3149,6 +3544,11 @@ extension type FormDataEventInit._(JSObject _) implements EventInit, JSObject { /// The **`HTMLDetailsElement`** interface provides special properties (beyond /// the regular [HTMLElement] interface it also has available to it by /// inheritance) for manipulating `details` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDetailsElement). extension type HTMLDetailsElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLDetailsElement] using the tag 'details'. @@ -3163,6 +3563,11 @@ extension type HTMLDetailsElement._(JSObject _) /// The **`HTMLDialogElement`** interface provides methods to manipulate /// `dialog` elements. It inherits properties and methods from the [HTMLElement] /// interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement). extension type HTMLDialogElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLDialogElement] using the tag 'dialog'. @@ -3205,6 +3610,11 @@ extension type HTMLDialogElement._(JSObject _) /// `text/csv`. If the script is blocked, its element receives an /// [HTMLElement/error_event] event; otherwise, it receives a /// [Window/load_event] event. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLScriptElement). extension type HTMLScriptElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLScriptElement] using the tag 'script'. @@ -3242,6 +3652,11 @@ extension type HTMLScriptElement._(JSObject _) /// The **`HTMLTemplateElement`** interface enables access to the contents of an /// HTML `template` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTemplateElement). extension type HTMLTemplateElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLTemplateElement] using the tag 'template'. @@ -3257,6 +3672,11 @@ extension type HTMLTemplateElement._(JSObject _) /// The **`HTMLSlotElement`** interface of the /// [Shadow DOM API](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM) /// enables access to the name and assigned nodes of an HTML `slot` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSlotElement). extension type HTMLSlotElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLSlotElement] using the tag 'slot'. HTMLSlotElement() : _ = document.createElement('slot'); @@ -3305,6 +3725,11 @@ extension type AssignedNodesOptions._(JSObject _) implements JSObject { /// manipulating the layout and presentation of `canvas` elements. The /// `HTMLCanvasElement` interface also inherits the properties and methods of /// the [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement). extension type HTMLCanvasElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLCanvasElement] using the tag 'canvas'. @@ -3414,6 +3839,11 @@ extension type CanvasRenderingContext2DSettings._(JSObject _) /// The offscreen rendering context inherits most of the same properties and /// methods as the `CanvasRenderingContext2D` and is described in more detail in /// the [OffscreenCanvasRenderingContext2D] reference page. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D). extension type CanvasRenderingContext2D._(JSObject _) implements JSObject { /// The **`CanvasRenderingContext2D.getContextAttributes()`** method returns /// an object that contains attributes used by the context. @@ -4218,6 +4648,11 @@ extension type CanvasRenderingContext2D._(JSObject _) implements JSObject { /// /// It can be used as a [CanvasRenderingContext2D.fillStyle] or /// [CanvasRenderingContext2D.strokeStyle]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CanvasGradient). extension type CanvasGradient._(JSObject _) implements JSObject { /// The **`CanvasGradient.addColorStop()`** method adds a new color stop, /// defined by an `offset` and a `color`, to a given canvas gradient. @@ -4234,6 +4669,11 @@ extension type CanvasGradient._(JSObject _) implements JSObject { /// /// It can be used as a [CanvasRenderingContext2D.fillStyle] or /// [CanvasRenderingContext2D.strokeStyle]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CanvasPattern). extension type CanvasPattern._(JSObject _) implements JSObject { /// The **`CanvasPattern.setTransform()`** method uses a [DOMMatrix] object as /// the pattern's transformation matrix and invokes it on the pattern. @@ -4243,6 +4683,11 @@ extension type CanvasPattern._(JSObject _) implements JSObject { /// The **`TextMetrics`** interface represents the dimensions of a piece of text /// in the canvas; a `TextMetrics` instance can be retrieved using the /// [CanvasRenderingContext2D.measureText] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TextMetrics). extension type TextMetrics._(JSObject _) implements JSObject { external num get width; external num get actualBoundingBoxLeft; @@ -4272,6 +4717,11 @@ extension type ImageDataSettings._(JSObject _) implements JSObject { /// [CanvasRenderingContext2D.createImageData] and /// [CanvasRenderingContext2D.getImageData]. It can also be used to set a part /// of the canvas by using [CanvasRenderingContext2D.putImageData]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ImageData). extension type ImageData._(JSObject _) implements JSObject { external factory ImageData( JSAny dataOrSw, @@ -4292,6 +4742,11 @@ extension type ImageData._(JSObject _) implements JSObject { /// of the `CanvasRenderingContext2D` interface are also present on this /// interface, which gives you the convenience of being able to retain and /// replay your path whenever desired. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Path2D). extension type Path2D._(JSObject _) implements JSObject { external factory Path2D([JSAny path]); @@ -4374,6 +4829,11 @@ extension type Path2D._(JSObject _) implements JSObject { /// This interface is available in both the window and the /// [worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) /// context. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmapRenderingContext). extension type ImageBitmapRenderingContext._(JSObject _) implements JSObject { /// The **`ImageBitmapRenderingContext.transferFromImageBitmap()`** /// method displays the given [ImageBitmap] in the canvas associated with this @@ -4424,6 +4884,11 @@ extension type ImageEncodeOptions._(JSObject _) implements JSObject { /// /// `OffscreenCanvas` is a /// [transferable object](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas). extension type OffscreenCanvas._(JSObject _) implements EventTarget, JSObject { external factory OffscreenCanvas( int width, @@ -4479,6 +4944,11 @@ extension type OffscreenCanvas._(JSObject _) implements EventTarget, JSObject { /// `canvas` element /// - it has a `commit()` method for pushing rendered images to the context's /// `OffscreenCanvas` object's placeholder `canvas` element +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvasRenderingContext2D). extension type OffscreenCanvasRenderingContext2D._(JSObject _) implements JSObject { /// The @@ -4750,6 +5220,11 @@ extension type OffscreenCanvasRenderingContext2D._(JSObject _) /// The **`CustomElementRegistry`** interface provides methods for registering /// custom elements and querying registered elements. To get an instance of it, /// use the [window.customElements] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry). extension type CustomElementRegistry._(JSObject _) implements JSObject { /// The **`define()`** method of the [CustomElementRegistry] interface adds a /// definition for a custom element to the custom element registry, mapping @@ -4798,6 +5273,11 @@ extension type ElementDefinitionOptions._(JSObject _) implements JSObject { /// exposes the /// [Accessibility Object Model](https://wicg.github.io/aom/explainer.html) to /// the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals). extension type ElementInternals._(JSObject _) implements JSObject { /// The **`setFormValue()`** method of the [ElementInternals] interface sets /// the element's submission value and state, communicating these to the user @@ -4890,6 +5370,11 @@ extension type ValidityStateFlags._(JSObject _) implements JSObject { /// /// The interface can be used to expose the internal states of a custom element, /// allowing them to be used in CSS selectors by code that uses the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CustomStateSet). extension type CustomStateSet._(JSObject _) implements JSObject {} /// The **`VisibilityStateEntry`** interface provides timings of page visibility @@ -4913,6 +5398,11 @@ extension type CustomStateSet._(JSObject _) implements JSObject {} /// /// > **Note:** Like other Performance APIs, this API extends /// > [PerformanceEntry]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/VisibilityStateEntry). extension type VisibilityStateEntry._(JSObject _) implements PerformanceEntry, JSObject { external String get name; @@ -4926,6 +5416,11 @@ extension type VisibilityStateEntry._(JSObject _) /// since page load. /// /// This API is only available in the window context and not exposed to workers. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/UserActivation). extension type UserActivation._(JSObject _) implements JSObject { external bool get hasBeenActive; external bool get isActive; @@ -4945,6 +5440,11 @@ extension type UserActivation._(JSObject _) implements JSObject { /// > [HTMLDetailsElement.toggle_event] event, which fires on a `details` /// > element when its `open`/`closed` state is toggled. Its event object is a /// > generic [Event]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent). extension type ToggleEvent._(JSObject _) implements Event, JSObject { external factory ToggleEvent( String type, [ @@ -5004,6 +5504,11 @@ extension type CloseWatcherOptions._(JSObject _) implements JSObject { /// /// This object is available from the [DragEvent.dataTransfer] property of all /// [DragEvent]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer). extension type DataTransfer._(JSObject _) implements JSObject { external factory DataTransfer(); @@ -5096,6 +5601,11 @@ extension type DataTransfer._(JSObject _) implements JSObject { /// `[]`. /// /// This interface has no constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList). extension type DataTransferItemList._(JSObject _) implements JSObject { /// The **`DataTransferItemList.add()`** method creates a new /// [DataTransferItem] using the specified data and adds it to the drag data @@ -5135,6 +5645,11 @@ extension type DataTransferItemList._(JSObject _) implements JSObject { /// list is a `DataTransferItem` object. /// /// This interface has no constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem). extension type DataTransferItem._(JSObject _) implements JSObject { /// If the item described by the [DataTransferItem] is a file, /// `webkitGetAsEntry()` returns a [FileSystemFileEntry] or @@ -5168,6 +5683,11 @@ extension type DataTransferItem._(JSObject _) implements JSObject { /// drag and drop interaction in an application-specific way. /// /// This interface inherits properties from [MouseEvent] and [Event]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent). extension type DragEvent._(JSObject _) implements MouseEvent, JSObject { external factory DragEvent( String type, [ @@ -5241,6 +5761,11 @@ external Window get window; /// contains the tab, such as [Window.resizeTo] and [Window.innerHeight]. /// Generally, anything that can't reasonably pertain to a tab pertains to the /// window instead. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Window). extension type Window._(JSObject _) implements EventTarget, JSObject { /// The [Window] interface's **`matchMedia()`** method /// returns a new [MediaQueryList] object that can then be used to determine @@ -5852,6 +6377,11 @@ extension type WindowPostMessageOptions._(JSObject _) /// /// The `BarProp` interface is not accessed directly, but via one of these /// elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/BarProp). extension type BarProp._(JSObject _) implements JSObject { external bool get visible; } @@ -5860,6 +6390,11 @@ extension type BarProp._(JSObject _) implements JSObject { /// is linked to. Changes done on it are reflected on the object it relates to. /// Both the [Document] and [Window] interface have such a linked `Location`, /// accessible via [Document.location] and [Window.location] respectively. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Location). extension type Location._(JSObject _) implements JSObject { /// The **`assign()`** method of the [Location] /// interface causes the window to load @@ -5909,6 +6444,11 @@ extension type Location._(JSObject _) implements JSObject { /// /// > **Note:** This interface is only available on the main thread ([Window]). /// > It cannot be accessed in [Worker] or [Worklet] contexts. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/History). extension type History._(JSObject _) implements JSObject { /// The **`go()`** method of the [History] interface loads a specific page /// from the @@ -5982,6 +6522,11 @@ extension type History._(JSObject _) implements JSObject { /// providing an accurate list of all previous history entries just for your /// app. This makes traversing the history a much less fragile proposition than /// with the older [History API]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Navigation). extension type Navigation._(JSObject _) implements EventTarget, JSObject { /// The **`entries()`** method of the /// [Navigation] interface returns an array of [NavigationHistoryEntry] @@ -6097,6 +6642,11 @@ extension type NavigationResult._(JSObject _) implements JSObject { /// providing an accurate list of all previous history entries just for your /// app. This makes traversing the history a much less fragile proposition than /// with the older [History API]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NavigationHistoryEntry). extension type NavigationHistoryEntry._(JSObject _) implements EventTarget, JSObject { /// The **`getState()`** method of the [NavigationHistoryEntry] interface @@ -6118,6 +6668,11 @@ extension type NavigationHistoryEntry._(JSObject _) /// stage. /// /// It is accessed via the [Navigation.transition] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NavigationTransition). extension type NavigationTransition._(JSObject _) implements JSObject { external NavigationType get navigationType; external NavigationHistoryEntry get from; @@ -6136,6 +6691,11 @@ extension type NavigationActivation._(JSObject _) implements JSObject { /// [History.go]). `NavigateEvent` provides access to information about that /// navigation, and allows developers to intercept and control the navigation /// handling. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NavigateEvent). extension type NavigateEvent._(JSObject _) implements Event, JSObject { external factory NavigateEvent( String type, @@ -6221,6 +6781,11 @@ extension type NavigationInterceptOptions._(JSObject _) implements JSObject { /// the destination being navigated to in the current navigation. /// /// It is accessed via the [NavigateEvent.destination] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NavigationDestination). extension type NavigationDestination._(JSObject _) implements JSObject { /// The **`getState()`** method of the /// [NavigationDestination] interface returns a clone of the @@ -6250,6 +6815,11 @@ extension type NavigationDestination._(JSObject _) implements JSObject { /// URL has changed and the [NavigationHistoryEntry] update has occurred. It is /// useful for migrating from usage of older API features like the /// [Window/hashchange_event] or [Window/popstate_event] events. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NavigationCurrentEntryChangeEvent). extension type NavigationCurrentEntryChangeEvent._(JSObject _) implements Event, JSObject { external factory NavigationCurrentEntryChangeEvent( @@ -6287,6 +6857,11 @@ extension type NavigationCurrentEntryChangeEventInit._(JSObject _) /// affected by a call to `history.replaceState()`, the `popstate` /// event's `state` property contains a copy of the history entry's state /// object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PopStateEvent). extension type PopStateEvent._(JSObject _) implements Event, JSObject { external factory PopStateEvent( String type, [ @@ -6316,6 +6891,11 @@ extension type PopStateEventInit._(JSObject _) implements EventInit, JSObject { /// /// The fragment identifier is the part of the URL that follows (and includes) /// the `#` symbol. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HashChangeEvent). extension type HashChangeEvent._(JSObject _) implements Event, JSObject { external factory HashChangeEvent( String type, [ @@ -6367,6 +6947,11 @@ extension type PageRevealEventInit._(JSObject _) /// and /// [`pagehide`](https://developer.mozilla.org/en-US/docs/Web/API/Window/pagehide_event) /// events, fired when a document is being loaded or unloaded. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PageTransitionEvent). extension type PageTransitionEvent._(JSObject _) implements Event, JSObject { external factory PageTransitionEvent( String type, [ @@ -6394,6 +6979,11 @@ extension type PageTransitionEventInit._(JSObject _) /// /// See the [Window/beforeunload_event] event reference for detailed guidance on /// using this event. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/BeforeUnloadEvent). extension type BeforeUnloadEvent._(JSObject _) implements Event, JSObject { external set returnValue(String value); external String get returnValue; @@ -6401,6 +6991,11 @@ extension type BeforeUnloadEvent._(JSObject _) implements Event, JSObject { /// The **`ErrorEvent`** interface represents events providing information /// related to errors in scripts or in files. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ErrorEvent). extension type ErrorEvent._(JSObject _) implements Event, JSObject { external factory ErrorEvent( String type, [ @@ -6443,6 +7038,11 @@ extension type ErrorEventInit._(JSObject _) implements EventInit, JSObject { /// /// For details, see /// [Promise rejection events](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#promise_rejection_events). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PromiseRejectionEvent). extension type PromiseRejectionEvent._(JSObject _) implements Event, JSObject { external factory PromiseRejectionEvent( String type, @@ -6491,6 +7091,11 @@ extension type PromiseRejectionEventInit._(JSObject _) /// > like `

` will be automatically closed if another /// > block-level element is nested inside and therefore parsed before the /// > closing `

` tag. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser). extension type DOMParser._(JSObject _) implements JSObject { external factory DOMParser(); @@ -6509,6 +7114,11 @@ extension type DOMParser._(JSObject _) implements JSObject { /// /// A `Navigator` object can be retrieved using the read-only [window.navigator] /// property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Navigator). extension type Navigator._(JSObject _) implements JSObject { /// The **`Navigator.requestMediaKeySystemAccess()`** method /// returns a `Promise` which delivers a [MediaKeySystemAccess] @@ -6653,6 +7263,11 @@ extension type Navigator._(JSObject _) implements JSObject { /// /// > **Note:** Own properties of `PluginArray` objects are no longer enumerable /// > in the latest browser versions. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PluginArray). extension type PluginArray._(JSObject _) implements JSObject { external void refresh(); external Plugin? item(int index); @@ -6671,6 +7286,11 @@ extension type PluginArray._(JSObject _) implements JSObject { /// > so you can treat them like ECMAScript arrays, and at the same time impose /// > additional semantics on their usage (such as making their items /// > read-only). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MimeTypeArray). extension type MimeTypeArray._(JSObject _) implements JSObject { external MimeType? item(int index); external MimeType? namedItem(String name); @@ -6681,6 +7301,11 @@ extension type MimeTypeArray._(JSObject _) implements JSObject { /// /// > **Note:** Own properties of `Plugin` objects are no longer enumerable in /// > the latest browser versions. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Plugin). extension type Plugin._(JSObject _) implements JSObject { external MimeType? item(int index); external MimeType? namedItem(String name); @@ -6693,6 +7318,11 @@ extension type Plugin._(JSObject _) implements JSObject { /// The **`MimeType`** interface provides contains information about a MIME type /// associated with a particular plugin. [Navigator.mimeTypes] returns an array /// of this object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MimeType). extension type MimeType._(JSObject _) implements JSObject { external String get type; external String get description; @@ -6708,6 +7338,11 @@ extension type MimeType._(JSObject _) implements JSObject { /// /// `ImageBitmap` is a /// [transferable object](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap). extension type ImageBitmap._(JSObject _) implements JSObject { /// The **`ImageBitmap.close()`** /// method disposes of all graphical resources associated with an @@ -6766,6 +7401,11 @@ extension type ImageBitmapOptions._(JSObject _) implements JSObject { /// The action triggered by this event is defined in a function set as the event /// handler for the relevant `message` event (e.g. using an `onmessage` handler /// as listed above). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent). extension type MessageEvent._(JSObject _) implements Event, JSObject { external factory MessageEvent( String type, [ @@ -6854,6 +7494,11 @@ extension type MessageEventInit._(JSObject _) implements EventInit, JSObject { /// > [Stackoverflow](https://stackoverflow.com/questions/5195452/websockets-vs-server-sent-events-eventsource/5326159)). /// > When using HTTP/2, the maximum number of simultaneous _HTTP streams_ is /// > negotiated between the server and the client (defaults to 100). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/EventSource). extension type EventSource._(JSObject _) implements EventTarget, JSObject { external factory EventSource( String url, [ @@ -6891,6 +7536,11 @@ extension type EventSourceInit._(JSObject _) implements JSObject { /// [Channel Messaging API](https://developer.mozilla.org/en-US/docs/Web/API/Channel_Messaging_API) /// allows us to create a new message channel and send data through it via its /// two [MessagePort] properties. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel). extension type MessageChannel._(JSObject _) implements JSObject { external factory MessageChannel(); @@ -6905,6 +7555,11 @@ extension type MessageChannel._(JSObject _) implements JSObject { /// /// `MessagePort` is a /// [transferable object](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort). extension type MessagePort._(JSObject _) implements EventTarget, JSObject { /// The **`postMessage()`** method of the /// [MessagePort] interface sends a message from the port, and optionally, @@ -6946,6 +7601,11 @@ extension type StructuredSerializeOptions._(JSObject _) implements JSObject { /// origin. Messages are broadcasted via a [BroadcastChannel/message_event] /// event fired at all `BroadcastChannel` objects listening to the channel, /// except the object that sent the message. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel). extension type BroadcastChannel._(JSObject _) implements EventTarget, JSObject { external factory BroadcastChannel(String name); @@ -6984,6 +7644,11 @@ extension type BroadcastChannel._(JSObject _) implements EventTarget, JSObject { /// for /// [ServiceWorker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API). /// The `self` property returns the specialized scope for each context. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope). extension type WorkerGlobalScope._(JSObject _) implements EventTarget, JSObject { /// The **`importScripts()`** method of the [WorkerGlobalScope] interface @@ -7055,6 +7720,11 @@ extension type WorkerGlobalScope._(JSObject _) /// [JavaScript Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference). /// See also: /// [Functions available to workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Functions_and_classes_available_to_workers). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DedicatedWorkerGlobalScope). extension type DedicatedWorkerGlobalScope._(JSObject _) implements WorkerGlobalScope, JSObject { /// The **`postMessage()`** method of the [DedicatedWorkerGlobalScope] @@ -7140,6 +7810,11 @@ extension type DedicatedWorkerGlobalScope._(JSObject _) /// [JavaScript Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference). /// See the complete list of /// [functions available to workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Functions_and_classes_available_to_workers). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SharedWorkerGlobalScope). extension type SharedWorkerGlobalScope._(JSObject _) implements WorkerGlobalScope, JSObject { /// The **`close()`** method of the [SharedWorkerGlobalScope] interface @@ -7167,6 +7842,11 @@ extension type SharedWorkerGlobalScope._(JSObject _) /// Note that not all interfaces and functions are available to web workers. See /// [Functions and classes available to Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Functions_and_classes_available_to_workers) /// for details. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Worker). extension type Worker._(JSObject _) implements EventTarget, JSObject { external factory Worker( String scriptURL, [ @@ -7224,6 +7904,11 @@ extension type WorkerOptions._(JSObject _) implements JSObject { /// > **Note:** If SharedWorker can be accessed from several browsing contexts, /// > all those browsing contexts must share the exact same origin (same /// > protocol, host and port). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker). extension type SharedWorker._(JSObject _) implements EventTarget, JSObject { external factory SharedWorker( String scriptURL, [ @@ -7239,6 +7924,11 @@ extension type SharedWorker._(JSObject _) implements EventTarget, JSObject { /// interface allowed to be accessed from a [Worker]. Such an object is /// initialized for each worker and is available via the /// [WorkerGlobalScope.navigator] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WorkerNavigator). extension type WorkerNavigator._(JSObject _) implements JSObject { external bool taintEnabled(); external MediaCapabilities get mediaCapabilities; @@ -7269,6 +7959,11 @@ extension type WorkerNavigator._(JSObject _) implements JSObject { /// /// This interface is only visible from inside a JavaScript script executed in /// the context of a Web worker. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WorkerLocation). extension type WorkerLocation._(JSObject _) implements JSObject { external String get href; external String get origin; @@ -7289,6 +7984,11 @@ extension type WorkerLocation._(JSObject _) implements JSObject { /// > base interface intended to be subclassed. You will encounter the /// > subclasses [AudioWorkletGlobalScope] inside [AudioWorklet] objects, or /// > [PaintWorkletGlobalScope] inside CSS paint [Worklet] objects. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WorkletGlobalScope). extension type WorkletGlobalScope._(JSObject _) implements JSObject {} /// The **`Worklet`** interface is a lightweight version of [Worker] and gives @@ -7306,6 +8006,11 @@ extension type WorkletGlobalScope._(JSObject _) implements JSObject {} /// Dynamic import is disallowed by the specification — calling /// [`import()`](/en-US/docs/Web/JavaScript/Reference/Operators/import) will /// throw. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Worklet). extension type Worklet._(JSObject _) implements JSObject { /// The **`addModule()`** method of the /// [Worklet] interface loads the module in the given JavaScript file and @@ -7331,6 +8036,11 @@ extension type WorkletOptions._(JSObject _) implements JSObject { /// To manipulate, for instance, the session storage for a domain, a call to /// [Window.sessionStorage] is made; whereas for local storage the call is made /// to [Window.localStorage]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Storage). extension type Storage._(JSObject _) implements JSObject { /// The **`key()`** method of the [Storage] interface, /// when passed a number n, returns the name of the nth key in a given @@ -7377,6 +8087,11 @@ extension type Storage._(JSObject _) implements JSObject { /// sent to a window /// when a storage area the window has access to is changed within the context /// of another document. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StorageEvent). extension type StorageEvent._(JSObject _) implements Event, JSObject { external factory StorageEvent( String type, [ @@ -7429,6 +8144,11 @@ extension type StorageEventInit._(JSObject _) implements EventInit, JSObject { /// `marquee` elements. /// /// It inherits properties and methods from the [HTMLElement] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMarqueeElement). extension type HTMLMarqueeElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLMarqueeElement] using the tag 'marquee'. @@ -7463,6 +8183,11 @@ extension type HTMLMarqueeElement._(JSObject _) /// The **`HTMLFrameSetElement`** interface provides special properties (beyond /// those of the regular [HTMLElement] interface they also inherit) for /// manipulating `frameset` elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFrameSetElement). extension type HTMLFrameSetElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLFrameSetElement] using the tag 'frameset'. @@ -7546,6 +8271,11 @@ extension type HTMLDirectoryElement._(JSObject _) /// Implements the document object model (DOM) representation of the font /// element. The HTML Font Element `font` defines the font size, font face and /// color of text. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFontElement). extension type HTMLFontElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLFontElement] using the tag 'font'. HTMLFontElement() : _ = document.createElement('font'); @@ -7562,6 +8292,11 @@ extension type HTMLFontElement._(JSObject _) implements HTMLElement, JSObject { /// those of the regular [HTMLElement] object interface it inherits) for /// manipulating `param` elements, representing a pair of a key and a value that /// acts as a parameter for an `object` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLParamElement). extension type HTMLParamElement._(JSObject _) implements HTMLElement, JSObject { /// Creates an [HTMLParamElement] using the tag 'param'. HTMLParamElement() : _ = document.createElement('param'); diff --git a/lib/src/dom/indexeddb.dart b/lib/src/dom/indexeddb.dart index 856efae5..261335e8 100644 --- a/lib/src/dom/indexeddb.dart +++ b/lib/src/dom/indexeddb.dart @@ -48,6 +48,11 @@ typedef IDBTransactionMode = String; /// `error` property and an error event is fired ([IDBRequest.error_event]). /// /// The interface [IDBOpenDBRequest] is derived from `IDBRequest`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBRequest). extension type IDBRequest._(JSObject _) implements EventTarget, JSObject { external JSAny? get result; external DOMException? get error; @@ -64,6 +69,11 @@ extension type IDBRequest._(JSObject _) implements EventTarget, JSObject { /// the results of requests to open or delete databases (performed using /// [IDBFactory.open] and [IDBFactory.deleteDatabase]), using specific event /// handler attributes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBOpenDBRequest). extension type IDBOpenDBRequest._(JSObject _) implements IDBRequest, JSObject { external set onblocked(EventHandler value); external EventHandler get onblocked; @@ -75,6 +85,11 @@ extension type IDBOpenDBRequest._(JSObject _) implements IDBRequest, JSObject { /// [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) /// indicates that the version of the database has changed, as the result of an /// [IDBOpenDBRequest.upgradeneeded_event] event handler function. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBVersionChangeEvent). extension type IDBVersionChangeEvent._(JSObject _) implements Event, JSObject { external factory IDBVersionChangeEvent( String type, [ @@ -106,6 +121,11 @@ extension type IDBVersionChangeEventInit._(JSObject _) /// that implements the interface is `window.indexedDB`. You open — that is, /// create and access — and delete a database with this object, and not directly /// with `IDBFactory`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory). extension type IDBFactory._(JSObject _) implements JSObject { /// The **`open()`** method of the [IDBFactory] interface requests opening a /// [connection to a database](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#database_connection). @@ -197,6 +217,11 @@ extension type IDBDatabaseInfo._(JSObject _) implements JSObject { /// > IndexedDB — including object stores, indexes, and cursors — are tied to a /// > particular transaction. Thus, you cannot execute commands, access data, or /// > open anything outside of a transaction. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase). extension type IDBDatabase._(JSObject _) implements EventTarget, JSObject { /// The **`transaction`** method of the [IDBDatabase] interface immediately /// returns a transaction object ([IDBTransaction]) containing the @@ -284,6 +309,11 @@ extension type IDBObjectStoreParameters._(JSObject _) implements JSObject { /// represents an object store in a database. Records within an object store are /// sorted according to their keys. This sorting enables fast insertion, /// look-up, and ordered retrieval. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore). extension type IDBObjectStore._(JSObject _) implements JSObject { /// The **`put()`** method of the [IDBObjectStore] interface updates a given /// record in a database, or inserts a new record if the given item does not @@ -559,6 +589,11 @@ extension type IDBIndexParameters._(JSObject _) implements JSObject { /// updated. /// /// You can grab a set of keys within a range. To learn more, see [IDBKeyRange]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex). extension type IDBIndex._(JSObject _) implements JSObject { /// The **`get()`** method of the [IDBIndex] /// interface returns an [IDBRequest] object, and, in a separate thread, @@ -706,6 +741,11 @@ extension type IDBIndex._(JSObject _) implements JSObject { /// - `undefined` /// - Greater than key value /// - Equal to key value if `upperOpen` is `false`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange). extension type IDBKeyRange._(JSObject _) implements JSObject { external static IDBKeyRange only(JSAny? value); external static IDBKeyRange lowerBound( @@ -752,6 +792,11 @@ extension type IDBKeyRange._(JSObject _) implements JSObject { /// You can have an unlimited number of cursors at the same time. You always get /// the same `IDBCursor` object representing a given cursor. Operations are /// performed on the underlying index or object store. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBCursor). extension type IDBCursor._(JSObject _) implements JSObject { /// The **`advance()`** method of the [IDBCursor] /// interface sets the number of times a cursor should move @@ -840,6 +885,11 @@ extension type IDBCursor._(JSObject _) implements JSObject { /// You can have an unlimited number of cursors at the same time. You always get /// the same `IDBCursorWithValue` object representing a given cursor. Operations /// are performed on the underlying index or object store. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBCursorWithValue). extension type IDBCursorWithValue._(JSObject _) implements IDBCursor, JSObject { external JSAny? get value; } @@ -867,6 +917,11 @@ extension type IDBCursorWithValue._(JSObject _) implements IDBCursor, JSObject { /// /// After the code is executed the object store should contain the value "2", /// since `trans2` should run after `trans1`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction). extension type IDBTransaction._(JSObject _) implements EventTarget, JSObject { /// The **`objectStore()`** method of the /// [IDBTransaction] interface returns an object store that has already been diff --git a/lib/src/dom/intersection_observer.dart b/lib/src/dom/intersection_observer.dart index c4111634..962e20dc 100644 --- a/lib/src/dom/intersection_observer.dart +++ b/lib/src/dom/intersection_observer.dart @@ -31,6 +31,11 @@ typedef IntersectionObserverCallback = JSFunction; /// object is only useful for watching for specific changes in degree of /// visibility; however, you can watch multiple target elements with the same /// observer. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver). extension type IntersectionObserver._(JSObject _) implements JSObject { external factory IntersectionObserver( IntersectionObserverCallback callback, [ @@ -113,6 +118,11 @@ extension type IntersectionObserver._(JSObject _) implements JSObject { /// Instances of `IntersectionObserverEntry` are delivered to an /// [IntersectionObserver] callback in its `entries` parameter; otherwise, these /// objects can only be obtained by calling [IntersectionObserver.takeRecords]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserverEntry). extension type IntersectionObserverEntry._(JSObject _) implements JSObject { external factory IntersectionObserverEntry( IntersectionObserverEntryInit intersectionObserverEntryInit); diff --git a/lib/src/dom/mathml_core.dart b/lib/src/dom/mathml_core.dart index ca3f6566..5e57deb8 100644 --- a/lib/src/dom/mathml_core.dart +++ b/lib/src/dom/mathml_core.dart @@ -20,6 +20,11 @@ import 'html.dart'; /// The **`MathMLElement`** interface represents any /// [MathML](https://developer.mozilla.org/en-US/docs/Web/MathML) element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MathMLElement). extension type MathMLElement._(JSObject _) implements Element, JSObject { /// Creates a [MathMLElement] using the tag 'math'. MathMLElement.math() diff --git a/lib/src/dom/media_capabilities.dart b/lib/src/dom/media_capabilities.dart index bba735cd..e2b8505f 100644 --- a/lib/src/dom/media_capabilities.dart +++ b/lib/src/dom/media_capabilities.dart @@ -205,6 +205,11 @@ extension type MediaCapabilitiesEncodingInfo._(JSObject _) /// /// The information is accessed through the **`mediaCapabilities`** property of /// the [Navigator] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaCapabilities). extension type MediaCapabilities._(JSObject _) implements JSObject { /// The **`MediaCapabilities.decodingInfo()`** method, part of the /// [Media Capabilities API](https://developer.mozilla.org/en-US/docs/Web/API/MediaCapabilities), diff --git a/lib/src/dom/media_playback_quality.dart b/lib/src/dom/media_playback_quality.dart index 4d3e98e0..00145744 100644 --- a/lib/src/dom/media_playback_quality.dart +++ b/lib/src/dom/media_playback_quality.dart @@ -18,6 +18,11 @@ import 'hr_time.dart'; /// A **`VideoPlaybackQuality`** object is returned by the /// [HTMLVideoElement.getVideoPlaybackQuality] method and contains metrics that /// can be used to determine the playback quality of a video. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/VideoPlaybackQuality). extension type VideoPlaybackQuality._(JSObject _) implements JSObject { external DOMHighResTimeStamp get creationTime; external int get droppedVideoFrames; diff --git a/lib/src/dom/media_source.dart b/lib/src/dom/media_source.dart index 4bac0e2a..c2b7ebd1 100644 --- a/lib/src/dom/media_source.dart +++ b/lib/src/dom/media_source.dart @@ -25,6 +25,11 @@ typedef AppendMode = String; /// represents a source of media data for an [HTMLMediaElement] object. A /// `MediaSource` object can be attached to a [HTMLMediaElement] to be played in /// the user agent. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaSource). extension type MediaSource._(JSObject _) implements EventTarget, JSObject { external factory MediaSource(); @@ -89,11 +94,21 @@ extension type MediaSource._(JSObject _) implements EventTarget, JSObject { /// the main thread using [DedicatedWorkerGlobalScope.postMessage], the handle /// instance in the worker is technically detached and can't be transferred /// again. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaSourceHandle). extension type MediaSourceHandle._(JSObject _) implements JSObject {} /// The **`SourceBuffer`** interface represents a chunk of media to be passed /// into an [HTMLMediaElement] and played, via a [MediaSource] object. This can /// be made up of one or several media segments. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SourceBuffer). extension type SourceBuffer._(JSObject _) implements EventTarget, JSObject { /// The **`appendBuffer()`** method of the /// [SourceBuffer] interface appends media segment data from an @@ -164,6 +179,11 @@ extension type SourceBuffer._(JSObject _) implements EventTarget, JSObject { /// The individual source buffers can be accessed using the /// [bracket notation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors#bracket_notation) /// `[]`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SourceBufferList). extension type SourceBufferList._(JSObject _) implements EventTarget, JSObject { external int get length; external set onaddsourcebuffer(EventHandler value); diff --git a/lib/src/dom/mediacapture_streams.dart b/lib/src/dom/mediacapture_streams.dart index 8448d8bd..96876c52 100644 --- a/lib/src/dom/mediacapture_streams.dart +++ b/lib/src/dom/mediacapture_streams.dart @@ -38,6 +38,11 @@ typedef MediaDeviceKind = String; /// calling functions such as [MediaDevices.getUserMedia], /// [MediaDevices.getDisplayMedia], or [HTMLCanvasElement.captureStream] and /// [HTMLMediaElement.captureStream]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream). extension type MediaStream._(JSObject _) implements EventTarget, JSObject { external factory MediaStream([JSObject streamOrTracks]); @@ -103,6 +108,11 @@ extension type MediaStream._(JSObject _) implements EventTarget, JSObject { /// /// Some user agents subclass this interface to provide more precise information /// or functionality, such as [CanvasCaptureMediaStreamTrack]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack). extension type MediaStreamTrack._(JSObject _) implements EventTarget, JSObject { /// The **`clone()`** method of the [MediaStreamTrack] /// interface creates a duplicate of the `MediaStreamTrack`. This new @@ -215,6 +225,11 @@ extension type MediaStreamTrack._(JSObject _) implements EventTarget, JSObject { /// To learn more about how constraints work, see [Capabilities, constraints, /// and /// settings](/en-US/docs/Web/API/Media_Capture_and_Streams_API/Constraints). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSupportedConstraints). extension type MediaTrackSupportedConstraints._(JSObject _) implements JSObject { external factory MediaTrackSupportedConstraints({ @@ -324,6 +339,11 @@ extension type MediaTrackCapabilities._(JSObject _) implements JSObject { /// preferred values or ranges of values for the track, and the most /// recently-requested set of custom constraints can be retrieved by calling /// [MediaStreamTrack.getConstraints]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints). extension type MediaTrackConstraints._(JSObject _) implements MediaTrackConstraintSet, JSObject { external factory MediaTrackConstraints({ @@ -410,6 +430,11 @@ extension type MediaTrackConstraintSet._(JSObject _) implements JSObject { /// To learn more about how constraints and settings work, see [Capabilities, /// constraints, and /// settings](/en-US/docs/Web/API/Media_Capture_and_Streams_API/Constraints). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings). extension type MediaTrackSettings._(JSObject _) implements JSObject { external factory MediaTrackSettings({ int width, @@ -470,6 +495,11 @@ extension type MediaTrackSettings._(JSObject _) implements JSObject { /// /// The events based on this interface are [MediaStream/addtrack_event] and /// [MediaStream/removetrack_event]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrackEvent). extension type MediaStreamTrackEvent._(JSObject _) implements Event, JSObject { external factory MediaStreamTrackEvent( String type, @@ -497,6 +527,11 @@ extension type MediaStreamTrackEventInit._(JSObject _) /// [MediaStreamTrack] cannot currently be met. When this event is thrown on a /// MediaStreamTrack, it is muted until either the current constraints can be /// established or until satisfiable constraints are applied. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/OverconstrainedError). extension type OverconstrainedError._(JSObject _) implements DOMException, JSObject { external factory OverconstrainedError( @@ -511,6 +546,11 @@ extension type OverconstrainedError._(JSObject _) /// provides access to connected media input devices like cameras and /// microphones, as well as screen sharing. In essence, it lets you obtain /// access to any hardware source of media data. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices). extension type MediaDevices._(JSObject _) implements EventTarget, JSObject { /// The **`enumerateDevices()`** method of the [MediaDevices] interface /// requests a list of the currently available media input and output devices, @@ -565,6 +605,11 @@ extension type MediaDevices._(JSObject _) implements EventTarget, JSObject { /// /// The list of devices obtained by calling [MediaDevices.enumerateDevices] is /// an array of `MediaDeviceInfo` objects, one per media device. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo). extension type MediaDeviceInfo._(JSObject _) implements JSObject { /// The **`toJSON()`** method of the [MediaDeviceInfo] interface is a ; it /// returns a JSON representation of the [MediaDeviceInfo] object. @@ -580,6 +625,11 @@ extension type MediaDeviceInfo._(JSObject _) implements JSObject { /// /// `InputDeviceInfo` objects are returned by [MediaDevices.enumerateDevices] if /// the returned device is an audio or video input device. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/InputDeviceInfo). extension type InputDeviceInfo._(JSObject _) implements MediaDeviceInfo, JSObject { /// The **`getCapabilities()`** method of the [InputDeviceInfo] interface diff --git a/lib/src/dom/mediasession.dart b/lib/src/dom/mediasession.dart index 4956fe7f..5b52f6e3 100644 --- a/lib/src/dom/mediasession.dart +++ b/lib/src/dom/mediasession.dart @@ -26,6 +26,11 @@ typedef MediaSessionAction = String; /// that provides controls for media playback and information display. A browser /// on the device can use `MediaSession` to make browser playback controllable /// from that standard/global user interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaSession). extension type MediaSession._(JSObject _) implements JSObject { /// The **`setActionHandler()`** method of the [MediaSession] interface sets a /// handler for a media session action. @@ -79,6 +84,11 @@ extension type MediaSession._(JSObject _) implements JSObject { /// The **`MediaMetadata`** interface of the [Media Session API] allows a web /// page to provide rich media metadata for display in a platform UI. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaMetadata). extension type MediaMetadata._(JSObject _) implements JSObject { external factory MediaMetadata([MediaMetadataInit init]); diff --git a/lib/src/dom/mediastream_recording.dart b/lib/src/dom/mediastream_recording.dart index b27e905e..314bbabd 100644 --- a/lib/src/dom/mediastream_recording.dart +++ b/lib/src/dom/mediastream_recording.dart @@ -26,6 +26,11 @@ typedef RecordingState = String; /// [MediaStream Recording API](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream_Recording_API) /// provides functionality to easily record media. It is created using the /// [MediaRecorder.MediaRecorder] constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder). extension type MediaRecorder._(JSObject _) implements EventTarget, JSObject { external factory MediaRecorder( MediaStream stream, [ @@ -186,6 +191,11 @@ extension type MediaRecorderOptions._(JSObject _) implements JSObject { /// [MediaStream Recording API](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream_Recording_API) /// represents events associated with a [Blob]. These blobs are typically, but /// not necessarily, associated with media content. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/BlobEvent). extension type BlobEvent._(JSObject _) implements Event, JSObject { external factory BlobEvent( String type, diff --git a/lib/src/dom/navigation_timing.dart b/lib/src/dom/navigation_timing.dart index 0cbc4f4e..205d055b 100644 --- a/lib/src/dom/navigation_timing.dart +++ b/lib/src/dom/navigation_timing.dart @@ -32,6 +32,11 @@ typedef NavigationTimingType = String; /// `PerformanceNavigationTiming`. /// /// ![Timestamp diagram listing timestamps in the order in which they are recorded for the fetching of a document](timestamp-diagram.svg) +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming). extension type PerformanceNavigationTiming._(JSObject _) implements PerformanceResourceTiming, JSObject { /// The **`toJSON()`** method of the [PerformanceNavigationTiming] interface @@ -60,6 +65,11 @@ extension type PerformanceNavigationTiming._(JSObject _) /// timing information for various events which occur during the loading and use /// of the current page. You get a `PerformanceTiming` object describing your /// page using the [Performance.timing] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceTiming). extension type PerformanceTiming._(JSObject _) implements JSObject { /// > **Warning:** This interface of this property is deprecated in the /// > [Navigation Timing Level 2 specification](https://w3c.github.io/navigation-timing/#obsolete). @@ -101,6 +111,11 @@ extension type PerformanceTiming._(JSObject _) implements JSObject { /// /// An object of this type can be obtained by calling the /// [Performance.navigation] read-only attribute. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigation). extension type PerformanceNavigation._(JSObject _) implements JSObject { external static int get TYPE_NAVIGATE; external static int get TYPE_RELOAD; diff --git a/lib/src/dom/notifications.dart b/lib/src/dom/notifications.dart index 126ad2e2..3b664da6 100644 --- a/lib/src/dom/notifications.dart +++ b/lib/src/dom/notifications.dart @@ -29,6 +29,11 @@ typedef NotificationDirection = String; /// These notifications' appearance and specific functionality vary across /// platforms but generally they provide a way to asynchronously provide /// information to the user. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Notification). extension type Notification._(JSObject _) implements EventTarget, JSObject { external factory Notification( String title, [ @@ -158,6 +163,11 @@ extension type GetNotificationOptions._(JSObject _) implements JSObject { /// > [ServiceWorkerGlobalScope] object, implement the `NotificationEvent` /// > interface. Non-persistent notification events, fired at the [Notification] /// > object, implement the `Event` interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NotificationEvent). extension type NotificationEvent._(JSObject _) implements ExtendableEvent, JSObject { external factory NotificationEvent( diff --git a/lib/src/dom/oes_draw_buffers_indexed.dart b/lib/src/dom/oes_draw_buffers_indexed.dart index 7b418332..8e30fb17 100644 --- a/lib/src/dom/oes_draw_buffers_indexed.dart +++ b/lib/src/dom/oes_draw_buffers_indexed.dart @@ -28,6 +28,11 @@ import 'webgl1.dart'; /// /// > **Note:** This extension is only available to [WebGL2RenderingContext] /// > contexts. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/OES_draw_buffers_indexed). extension type OES_draw_buffers_indexed._(JSObject _) implements JSObject { /// The `enableiOES()` method of the [OES_draw_buffers_indexed] WebGL /// extension enables blending for a particular draw buffer. diff --git a/lib/src/dom/orientation_event.dart b/lib/src/dom/orientation_event.dart index 038dc8ac..fb939e10 100644 --- a/lib/src/dom/orientation_event.dart +++ b/lib/src/dom/orientation_event.dart @@ -18,6 +18,11 @@ import 'dom.dart'; /// The **`DeviceOrientationEvent`** interface of the /// [Device Orientation Events] provides web developers with information from /// the physical orientation of the device running the web page. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent). extension type DeviceOrientationEvent._(JSObject _) implements Event, JSObject { external factory DeviceOrientationEvent( String type, [ @@ -55,6 +60,11 @@ extension type DeviceOrientationEventInit._(JSObject _) /// The **`DeviceMotionEventAcceleration`** interface of the /// [Device Orientation Events] provides information about the amount of /// acceleration the device is experiencing along all three axes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEventAcceleration). extension type DeviceMotionEventAcceleration._(JSObject _) implements JSObject { external num? get x; external num? get y; @@ -64,6 +74,11 @@ extension type DeviceMotionEventAcceleration._(JSObject _) implements JSObject { /// A **`DeviceMotionEventRotationRate`** interface of the /// [Device Orientation Events] provides information about the rate at which the /// device is rotating around all three axes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEventRotationRate). extension type DeviceMotionEventRotationRate._(JSObject _) implements JSObject { external num? get alpha; external num? get beta; @@ -76,6 +91,11 @@ extension type DeviceMotionEventRotationRate._(JSObject _) implements JSObject { /// /// > **Warning:** Currently, Firefox and Chrome do not handle the coordinates /// > the same way. Take care about this while using them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent). extension type DeviceMotionEvent._(JSObject _) implements Event, JSObject { external factory DeviceMotionEvent( String type, [ diff --git a/lib/src/dom/paint_timing.dart b/lib/src/dom/paint_timing.dart index 091e8a7b..efc2382b 100644 --- a/lib/src/dom/paint_timing.dart +++ b/lib/src/dom/paint_timing.dart @@ -36,5 +36,10 @@ import 'performance_timeline.dart'; /// performant, and engaging for your users. /// /// Like other Performance APIs, this API extends [PerformanceEntry]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformancePaintTiming). extension type PerformancePaintTiming._(JSObject _) implements PerformanceEntry, JSObject {} diff --git a/lib/src/dom/payment_request.dart b/lib/src/dom/payment_request.dart index 58296d6a..cd02ca78 100644 --- a/lib/src/dom/payment_request.dart +++ b/lib/src/dom/payment_request.dart @@ -22,6 +22,11 @@ typedef PaymentComplete = String; /// **`PaymentRequest`** interface is the primary access point into the API, and /// lets web content and apps accept payments from the end user on behalf of the /// operator of the site or the publisher of the app. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest). extension type PaymentRequest._(JSObject _) implements EventTarget, JSObject { external factory PaymentRequest( JSArray methodData, @@ -201,6 +206,11 @@ extension type PaymentCompleteDetails._(JSObject _) implements JSObject { /// [Payment Request API](https://developer.mozilla.org/en-US/docs/Web/API/Payment_Request_API) /// is returned after a user selects a payment method and approves a payment /// request. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PaymentResponse). extension type PaymentResponse._(JSObject _) implements EventTarget, JSObject { /// The **`toJSON()`** method of the [PaymentResponse] interface is a ; it /// returns a JSON representation of the [PaymentResponse] object. @@ -252,6 +262,11 @@ extension type PaymentValidationErrors._(JSObject _) implements JSObject { /// fired by some payment handlers when the user switches payment instruments /// (e.g., a user selects a "store" card to make a purchase while using Apple /// Pay). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PaymentMethodChangeEvent). extension type PaymentMethodChangeEvent._(JSObject _) implements PaymentRequestUpdateEvent, JSObject { external factory PaymentMethodChangeEvent( @@ -286,6 +301,11 @@ extension type PaymentMethodChangeEventInit._(JSObject _) /// - : Dispatched whenever the user changes their shipping address. /// - [PaymentRequest.shippingoptionchange_event] /// - : Dispatched whenever the user changes a shipping option. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequestUpdateEvent). extension type PaymentRequestUpdateEvent._(JSObject _) implements Event, JSObject { external factory PaymentRequestUpdateEvent( diff --git a/lib/src/dom/performance_timeline.dart b/lib/src/dom/performance_timeline.dart index 5ad08165..6112fb4c 100644 --- a/lib/src/dom/performance_timeline.dart +++ b/lib/src/dom/performance_timeline.dart @@ -44,6 +44,11 @@ typedef PerformanceObserverCallback = JSFunction; /// - [PerformanceServerTiming] /// - [TaskAttributionTiming] /// - [VisibilityStateEntry] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry). extension type PerformanceEntry._(JSObject _) implements JSObject { /// The **`toJSON()`** method is a ; it returns a JSON representation of the /// [PerformanceEntry] object. @@ -59,6 +64,11 @@ extension type PerformanceEntry._(JSObject _) implements JSObject { /// The **`PerformanceObserver`** interface is used to observe performance /// measurement events and be notified of new [PerformanceEntry] as they are /// recorded in the browser's _performance timeline_. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceObserver). extension type PerformanceObserver._(JSObject _) implements JSObject { external factory PerformanceObserver(PerformanceObserverCallback callback); @@ -111,6 +121,11 @@ extension type PerformanceObserverInit._(JSObject _) implements JSObject { /// The **`PerformanceObserverEntryList`** interface is a list of /// [PerformanceEntry] that were explicitly observed via the /// [PerformanceObserver.observe] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceObserverEntryList). extension type PerformanceObserverEntryList._(JSObject _) implements JSObject { /// The **`getEntries()`** method of the [PerformanceObserverEntryList] /// interface returns a list of explicitly observed [PerformanceEntry] diff --git a/lib/src/dom/permissions.dart b/lib/src/dom/permissions.dart index 090842f4..e03378ba 100644 --- a/lib/src/dom/permissions.dart +++ b/lib/src/dom/permissions.dart @@ -22,6 +22,11 @@ typedef PermissionState = String; /// [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API) /// provides the core Permission API functionality, such as methods for querying /// and revoking permissions +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Permissions). extension type Permissions._(JSObject _) implements JSObject { /// The **`Permissions.query()`** method of the [Permissions] interface /// returns the state of a user permission on the global scope. @@ -38,6 +43,11 @@ extension type PermissionDescriptor._(JSObject _) implements JSObject { /// [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API) /// provides the state of an object and an event handler for monitoring changes /// to said state. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PermissionStatus). extension type PermissionStatus._(JSObject _) implements EventTarget, JSObject { external PermissionState get state; external String get name; diff --git a/lib/src/dom/pointerevents.dart b/lib/src/dom/pointerevents.dart index 21f7925e..39173b7b 100644 --- a/lib/src/dom/pointerevents.dart +++ b/lib/src/dom/pointerevents.dart @@ -107,6 +107,11 @@ extension type PointerEventInit._(JSObject _) /// element for a pointer event. Typically, this is determined by considering /// the pointer's location and also the visual layout of elements in a document /// on screen media. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent). extension type PointerEvent._(JSObject _) implements MouseEvent, JSObject { external factory PointerEvent( String type, [ diff --git a/lib/src/dom/push_api.dart b/lib/src/dom/push_api.dart index 414dd45d..d925b7ea 100644 --- a/lib/src/dom/push_api.dart +++ b/lib/src/dom/push_api.dart @@ -38,6 +38,11 @@ extension type PushPermissionDescriptor._(JSObject _) /// /// This interface is accessed via the [ServiceWorkerRegistration.pushManager] /// property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PushManager). extension type PushManager._(JSObject _) implements JSObject { external static JSArray get supportedContentEncodings; @@ -79,6 +84,11 @@ extension type PushManager._(JSObject _) implements JSObject { /// The read-only `PushSubscriptionOptions` object is returned by calling /// [PushSubscription.options] on a [PushSubscription]. This interface has no /// constructor of its own. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscriptionOptions). extension type PushSubscriptionOptions._(JSObject _) implements JSObject { external bool get userVisibleOnly; external JSArrayBuffer? get applicationServerKey; @@ -101,6 +111,11 @@ extension type PushSubscriptionOptionsInit._(JSObject _) implements JSObject { /// service. /// /// An instance of this interface can be serialized. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription). extension type PushSubscription._(JSObject _) implements JSObject { /// The `getKey()` method of the [PushSubscription] interface /// returns an `ArrayBuffer` representing a client public key, which can then @@ -149,6 +164,11 @@ extension type PushSubscriptionJSON._(JSObject _) implements JSObject { /// Messages received through the Push API are sent encrypted by push services /// and then automatically decrypted by browsers before they are made accessible /// through the methods of the `PushMessageData` interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PushMessageData). extension type PushMessageData._(JSObject _) implements JSObject { /// The **`arrayBuffer()`** method of the [PushMessageData] interface extracts /// push message data as an `ArrayBuffer` object. @@ -175,6 +195,11 @@ extension type PushMessageData._(JSObject _) implements JSObject { /// [global scope](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope) /// of a [ServiceWorker]. It contains the information sent from an application /// server to a [PushSubscription]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PushEvent). extension type PushEvent._(JSObject _) implements ExtendableEvent, JSObject { external factory PushEvent( String type, [ diff --git a/lib/src/dom/reporting.dart b/lib/src/dom/reporting.dart index 413d19d6..987a0ff6 100644 --- a/lib/src/dom/reporting.dart +++ b/lib/src/dom/reporting.dart @@ -28,6 +28,11 @@ typedef ReportingObserverCallback = JSFunction; /// /// An instance of `ReportBody` is returned as the value of [Report.body]. The /// interface has no constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReportBody). extension type ReportBody._(JSObject _) implements JSObject { /// The **`toJSON()`** method of the [ReportBody] interface is a _serializer_, /// and returns a JSON representation of the `ReportBody` object. @@ -47,6 +52,11 @@ extension type ReportBody._(JSObject _) implements JSObject { /// constructor upon creation of a new observer instance. This contains the /// list of reports currently contained in the observer's report queue. /// - By sending requests to the endpoints defined via the HTTP header. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Report). extension type Report._(JSObject _) implements JSObject { external JSObject toJSON(); external String get type; @@ -57,6 +67,11 @@ extension type Report._(JSObject _) implements JSObject { /// The `ReportingObserver` interface of the /// [Reporting API](https://developer.mozilla.org/en-US/docs/Web/API/Reporting_API) /// allows you to collect and access reports. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReportingObserver). extension type ReportingObserver._(JSObject _) implements JSObject { external factory ReportingObserver( ReportingObserverCallback callback, [ diff --git a/lib/src/dom/resize_observer.dart b/lib/src/dom/resize_observer.dart index 6bae1e6d..f09d8a93 100644 --- a/lib/src/dom/resize_observer.dart +++ b/lib/src/dom/resize_observer.dart @@ -33,6 +33,11 @@ extension type ResizeObserverOptions._(JSObject _) implements JSObject { /// > encompasses the content, padding, and border. See /// > [The box model](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/The_box_model) /// > for further explanation. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver). extension type ResizeObserver._(JSObject _) implements JSObject { external factory ResizeObserver(ResizeObserverCallback callback); @@ -59,6 +64,11 @@ extension type ResizeObserver._(JSObject _) implements JSObject { /// [ResizeObserver.ResizeObserver] constructor's callback function, which /// allows you to access the new dimensions of the [Element] or [SVGElement] /// being observed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry). extension type ResizeObserverEntry._(JSObject _) implements JSObject { external Element get target; external DOMRectReadOnly get contentRect; @@ -75,6 +85,11 @@ extension type ResizeObserverEntry._(JSObject _) implements JSObject { /// > [multi-column layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_multicol_layout), /// > which is a fragmented context, the sizing returned by `ResizeObserverSize` /// > will be the size of the first column. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverSize). extension type ResizeObserverSize._(JSObject _) implements JSObject { external num get inlineSize; external num get blockSize; diff --git a/lib/src/dom/resource_timing.dart b/lib/src/dom/resource_timing.dart index ddb87a92..0517fd8a 100644 --- a/lib/src/dom/resource_timing.dart +++ b/lib/src/dom/resource_timing.dart @@ -24,6 +24,11 @@ typedef RenderBlockingStatusType = String; /// resources. An application can use the timing metrics to determine, for /// example, the length of time it takes to fetch a specific resource, such as /// an [XMLHttpRequest], , image, or script. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming). extension type PerformanceResourceTiming._(JSObject _) implements PerformanceEntry, JSObject { /// The **`toJSON()`** method of the [PerformanceResourceTiming] interface is diff --git a/lib/src/dom/screen_orientation.dart b/lib/src/dom/screen_orientation.dart index 8853f286..3e6383e5 100644 --- a/lib/src/dom/screen_orientation.dart +++ b/lib/src/dom/screen_orientation.dart @@ -25,6 +25,11 @@ typedef OrientationType = String; /// /// A **`ScreenOrientation`** instance object can be retrieved using the /// [screen.orientation] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation). extension type ScreenOrientation._(JSObject _) implements EventTarget, JSObject { /// The **`lock()`** property of the [ScreenOrientation] interface locks the diff --git a/lib/src/dom/screen_wake_lock.dart b/lib/src/dom/screen_wake_lock.dart index 80e3754e..150d41eb 100644 --- a/lib/src/dom/screen_wake_lock.dart +++ b/lib/src/dom/screen_wake_lock.dart @@ -25,6 +25,11 @@ typedef WakeLockType = String; /// /// This interface, and hence the system wake lock, is exposed through the /// [Navigator.wakeLock] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WakeLock). extension type WakeLock._(JSObject _) implements JSObject { /// The **`request()`** method of the [WakeLock] interface returns a `Promise` /// that fullfills with a [WakeLockSentinel] object if the system screen wake @@ -60,6 +65,11 @@ extension type WakeLock._(JSObject _) implements JSObject { /// An event is fired at the `WakeLockSentinel` if the platform lock is /// released, allowing applications to configure their UI, and re-request the /// lock if needed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WakeLockSentinel). extension type WakeLockSentinel._(JSObject _) implements EventTarget, JSObject { /// The **`release()`** method of the [WakeLockSentinel] interface releases /// the [WakeLockSentinel], returning a `Promise` that is resolved once the diff --git a/lib/src/dom/selection_api.dart b/lib/src/dom/selection_api.dart index beb0727b..cfa7ec06 100644 --- a/lib/src/dom/selection_api.dart +++ b/lib/src/dom/selection_api.dart @@ -29,6 +29,11 @@ import 'dom.dart'; /// > **Note:** _Anchor_ and _focus_ should not be confused with the _start_ and /// > _end_ positions of a selection. The anchor can be placed before the focus /// > or vice versa, depending on the direction you made your selection. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Selection). extension type Selection._(JSObject _) implements JSObject { /// The **`Selection.getRangeAt()`** method returns a range object /// representing one of the ranges currently selected. diff --git a/lib/src/dom/server_timing.dart b/lib/src/dom/server_timing.dart index a208de79..7b897ac5 100644 --- a/lib/src/dom/server_timing.dart +++ b/lib/src/dom/server_timing.dart @@ -22,6 +22,11 @@ import 'hr_time.dart'; /// to specify the domains that are allowed to access the server metrics. Note /// that this interface is only available in secure contexts (HTTPS) in some /// browsers. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceServerTiming). extension type PerformanceServerTiming._(JSObject _) implements JSObject { /// The **`toJSON()`** method of the [PerformanceServerTiming] interface is a /// ; it returns a JSON representation of the [PerformanceServerTiming] diff --git a/lib/src/dom/service_workers.dart b/lib/src/dom/service_workers.dart index f18784fd..323e0e48 100644 --- a/lib/src/dom/service_workers.dart +++ b/lib/src/dom/service_workers.dart @@ -53,6 +53,11 @@ typedef ClientType = String; /// Dynamic import is disallowed by the specification — calling /// [`import()`](/en-US/docs/Web/JavaScript/Reference/Operators/import) will /// throw. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker). extension type ServiceWorker._(JSObject _) implements EventTarget, JSObject { /// The **`postMessage()`** method of the [ServiceWorker] interface sends a /// message to the worker. The first parameter is the data to send to the @@ -84,6 +89,11 @@ extension type ServiceWorker._(JSObject _) implements EventTarget, JSObject { /// `ServiceWorkerRegistration` objects that represent them within the lifetime /// of their corresponding service worker clients. The browser maintains a /// persistent list of active `ServiceWorkerRegistration` objects. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration). extension type ServiceWorkerRegistration._(JSObject _) implements EventTarget, JSObject { /// The **`showNotification()`** method of the @@ -149,6 +159,11 @@ extension type ServiceWorkerRegistration._(JSObject _) /// used to register service workers, and the /// [ServiceWorkerContainer.controller] property used to determine whether or /// not the current page is actively controlled. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer). extension type ServiceWorkerContainer._(JSObject _) implements EventTarget, JSObject { /// The **`register()`** method of the @@ -229,6 +244,11 @@ extension type RegistrationOptions._(JSObject _) implements JSObject { /// [ServiceWorkerRegistration.navigationPreload]. /// The result of a preload fetch request is waited on using the promise /// returned by [FetchEvent.preloadResponse]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/NavigationPreloadManager). extension type NavigationPreloadManager._(JSObject _) implements JSObject { /// The **`enable()`** method of the [NavigationPreloadManager] interface is /// used to enable preloading of resources managed by the service worker. @@ -303,6 +323,11 @@ extension type NavigationPreloadState._(JSObject _) implements JSObject { /// /// This interface inherits from the [WorkerGlobalScope] interface, and its /// parent [EventTarget]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope). extension type ServiceWorkerGlobalScope._(JSObject _) implements WorkerGlobalScope, JSObject { /// The **`ServiceWorkerGlobalScope.skipWaiting()`** method of the @@ -340,6 +365,11 @@ extension type ServiceWorkerGlobalScope._(JSObject _) /// or a [SharedWorker]. [Window] clients are represented by the more-specific /// [WindowClient]. You can get `Client`/`WindowClient` objects from methods /// such as [Clients.matchAll] and [Clients.get]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Client). extension type Client._(JSObject _) implements JSObject { /// The **`postMessage()`** method of the /// [Client] interface allows a service worker to send a message to a client @@ -362,6 +392,11 @@ extension type Client._(JSObject _) implements JSObject { /// browsing context, controlled by an active worker. The service worker client /// independently selects and uses a service worker for its own loading and /// sub-resources. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WindowClient). extension type WindowClient._(JSObject _) implements Client, JSObject { /// The **`focus()`** method of the [WindowClient] /// interface gives user input focus to the current client and returns a @@ -382,6 +417,11 @@ extension type WindowClient._(JSObject _) implements Client, JSObject { /// The `Clients` interface provides access to [Client] objects. Access it via /// `[ServiceWorkerGlobalScope].clients` within a /// [service worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Clients). extension type Clients._(JSObject _) implements JSObject { /// The **`get()`** method of the /// [Clients] interface gets a service worker client matching a given @@ -466,6 +506,11 @@ extension type ClientQueryOptions._(JSObject _) implements JSObject { /// > **Note:** This interface is only available when the global scope is a /// > [ServiceWorkerGlobalScope]. It is not available when it is a [Window], or /// > the scope of another kind of worker. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ExtendableEvent). extension type ExtendableEvent._(JSObject _) implements Event, JSObject { external factory ExtendableEvent( String type, [ @@ -522,6 +567,11 @@ extension type ExtendableEventInit._(JSObject _) /// including the request and how the receiver will treat the response. It /// provides the [FetchEvent.respondWith] method, which allows us to provide a /// response to this fetch. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent). extension type FetchEvent._(JSObject _) implements ExtendableEvent, JSObject { external factory FetchEvent( String type, @@ -635,6 +685,11 @@ extension type FetchEventInit._(JSObject _) /// such events. /// /// This interface inherits from the [ExtendableEvent] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ExtendableMessageEvent). extension type ExtendableMessageEvent._(JSObject _) implements ExtendableEvent, JSObject { external factory ExtendableMessageEvent( @@ -705,6 +760,11 @@ extension type ExtendableMessageEventInit._(JSObject _) /// > for entries in the `Cache` object. /// /// > **Note:** The caching API doesn't honor HTTP caching headers. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Cache). extension type Cache._(JSObject _) implements JSObject { /// The **`match()`** method of the [Cache] interface returns a `Promise` that /// resolves to the [Response] associated with the first matching request in @@ -854,6 +914,11 @@ extension type CacheQueryOptions._(JSObject _) implements JSObject { /// > functionality to match a cache entry can be implemented by returning an /// > array of cache names from [CacheStorage.keys], opening each cache with /// > [CacheStorage.open], and matching the one you want with [Cache.match]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CacheStorage). extension type CacheStorage._(JSObject _) implements JSObject { /// The **`match()`** method of the [CacheStorage] interface checks if a given /// [Request] or URL string is a key for a stored [Response]. diff --git a/lib/src/dom/speech_api.dart b/lib/src/dom/speech_api.dart index c6d9bf46..3e9dd96b 100644 --- a/lib/src/dom/speech_api.dart +++ b/lib/src/dom/speech_api.dart @@ -27,6 +27,11 @@ typedef SpeechSynthesisErrorCode = String; /// > **Note:** On some browsers, like Chrome, using Speech Recognition on a web /// > page involves a server-based recognition engine. Your audio is sent to a /// > web service for recognition processing, so it won't work offline. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition). extension type SpeechRecognition._(JSObject _) implements EventTarget, JSObject { external factory SpeechRecognition(); @@ -91,6 +96,11 @@ extension type SpeechRecognition._(JSObject _) /// The **`SpeechRecognitionErrorEvent`** interface of the /// [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) /// represents error messages from the recognition service. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognitionErrorEvent). extension type SpeechRecognitionErrorEvent._(JSObject _) implements Event, JSObject { external factory SpeechRecognitionErrorEvent( @@ -121,6 +131,11 @@ extension type SpeechRecognitionErrorEventInit._(JSObject _) /// [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) /// represents a single word that has been recognized by the speech recognition /// service. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognitionAlternative). extension type SpeechRecognitionAlternative._(JSObject _) implements JSObject { external String get transcript; external num get confidence; @@ -130,6 +145,11 @@ extension type SpeechRecognitionAlternative._(JSObject _) implements JSObject { /// [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) /// represents a single recognition match, which may contain multiple /// [SpeechRecognitionAlternative] objects. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognitionResult). extension type SpeechRecognitionResult._(JSObject _) implements JSObject { /// The **`item`** getter of the /// [SpeechRecognitionResult] interface is a standard getter that allows @@ -145,6 +165,11 @@ extension type SpeechRecognitionResult._(JSObject _) implements JSObject { /// [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) /// represents a list of [SpeechRecognitionResult] objects, or a single one if /// results are being captured in mode. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognitionResultList). extension type SpeechRecognitionResultList._(JSObject _) implements JSObject { /// The **`item`** getter of the /// [SpeechRecognitionResultList] interface is a standard getter — it allows @@ -159,6 +184,11 @@ extension type SpeechRecognitionResultList._(JSObject _) implements JSObject { /// represents the event object for the [SpeechRecognition.result_event] and /// [SpeechRecognition.nomatch_event] events, and contains all the data /// associated with an interim or final speech recognition result. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognitionEvent). extension type SpeechRecognitionEvent._(JSObject _) implements Event, JSObject { external factory SpeechRecognitionEvent( String type, @@ -192,6 +222,11 @@ extension type SpeechRecognitionEventInit._(JSObject _) /// Grammar is defined using /// [JSpeech Grammar Format](https://www.w3.org/TR/jsgf/) (**JSGF**.) Other /// formats may also be supported in the future. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechGrammar). extension type SpeechGrammar._(JSObject _) implements JSObject { external set src(String value); external String get src; @@ -207,6 +242,11 @@ extension type SpeechGrammar._(JSObject _) implements JSObject { /// Grammar is defined using /// [JSpeech Grammar Format](https://www.w3.org/TR/jsgf/) (**JSGF**.) Other /// formats may also be supported in the future. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechGrammarList). extension type SpeechGrammarList._(JSObject _) implements JSObject { external factory SpeechGrammarList(); @@ -245,6 +285,11 @@ extension type SpeechGrammarList._(JSObject _) implements JSObject { /// is the controller interface for the speech service; this can be used to /// retrieve information about the synthesis voices available on the device, /// start and pause speech, and other commands besides. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis). extension type SpeechSynthesis._(JSObject _) implements EventTarget, JSObject { /// The **`speak()`** method of the [SpeechSynthesis] /// interface adds an [SpeechSynthesisUtterance] to the utterance @@ -285,6 +330,11 @@ extension type SpeechSynthesis._(JSObject _) implements EventTarget, JSObject { /// represents a speech request. /// It contains the content the speech service should read and information about /// how to read it (e.g. language, pitch and volume.) +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance). extension type SpeechSynthesisUtterance._(JSObject _) implements EventTarget, JSObject { external factory SpeechSynthesisUtterance([String text]); @@ -321,6 +371,11 @@ extension type SpeechSynthesisUtterance._(JSObject _) /// [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) /// contains information about the current state of [SpeechSynthesisUtterance] /// objects that have been processed in the speech service. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisEvent). extension type SpeechSynthesisEvent._(JSObject _) implements Event, JSObject { external factory SpeechSynthesisEvent( String type, @@ -362,6 +417,11 @@ extension type SpeechSynthesisEventInit._(JSObject _) /// [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) /// contains information about any errors that occur while processing /// [SpeechSynthesisUtterance] objects in the speech service. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisErrorEvent). extension type SpeechSynthesisErrorEvent._(JSObject _) implements SpeechSynthesisEvent, JSObject { external factory SpeechSynthesisErrorEvent( @@ -394,6 +454,11 @@ extension type SpeechSynthesisErrorEventInit._(JSObject _) /// represents a voice that the system supports. /// Every `SpeechSynthesisVoice` has its own relative speech service including /// information about language, name and URI. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisVoice). extension type SpeechSynthesisVoice._(JSObject _) implements JSObject { external String get voiceURI; external String get name; diff --git a/lib/src/dom/storage.dart b/lib/src/dom/storage.dart index ec5b670a..e411f496 100644 --- a/lib/src/dom/storage.dart +++ b/lib/src/dom/storage.dart @@ -20,6 +20,11 @@ import 'fs.dart'; /// provides an interface for managing persistence permissions and estimating /// available storage. You can get a reference to this interface using either /// [navigator.storage] or [WorkerNavigator.storage]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StorageManager). extension type StorageManager._(JSObject _) implements JSObject { /// The **`getDirectory()`** method of the [StorageManager] interface is used /// to obtain a reference to a [FileSystemDirectoryHandle] object allowing diff --git a/lib/src/dom/streams.dart b/lib/src/dom/streams.dart index 14269250..9d5d7e6f 100644 --- a/lib/src/dom/streams.dart +++ b/lib/src/dom/streams.dart @@ -42,6 +42,11 @@ typedef ReadableStreamType = String; /// /// `ReadableStream` is a /// [transferable object](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream). extension type ReadableStream._(JSObject _) implements JSObject { external factory ReadableStream([ JSObject underlyingSource, @@ -221,6 +226,11 @@ extension type UnderlyingSource._(JSObject _) implements JSObject { /// [`autoAllocateChunkSize`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream#autoallocatechunksize). /// For any other underlying source, the stream will always satisfy read /// requests with data from internal queues. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader). extension type ReadableStreamDefaultReader._(JSObject _) implements JSObject { external factory ReadableStreamDefaultReader(ReadableStream stream); @@ -303,6 +313,11 @@ extension type ReadableStreamReadResult._(JSObject _) implements JSObject { /// reader ([ReadableStreamDefaultReader]). /// The `read()` method differs in that it provide a view into which data should /// be written. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader). extension type ReadableStreamBYOBReader._(JSObject _) implements JSObject { external factory ReadableStreamBYOBReader(ReadableStream stream); @@ -379,6 +394,11 @@ extension type ReadableStreamBYOBReaderReadOptions._(JSObject _) /// represents a controller allowing control of a [ReadableStream]'s state and /// internal queue. Default controllers are for streams that are not byte /// streams. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultController). extension type ReadableStreamDefaultController._(JSObject _) implements JSObject { /// The **`close()`** method of the @@ -465,6 +485,11 @@ extension type ReadableStreamDefaultController._(JSObject _) /// Note that even though the controller is primarily used by the underlying /// byte source, there is no reason it cannot be stored used by other parts of /// the system to signal the stream. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController). extension type ReadableByteStreamController._(JSObject _) implements JSObject { /// The **`close()`** method of the [ReadableByteStreamController] interface /// closes the associated stream. @@ -546,6 +571,11 @@ extension type ReadableByteStreamController._(JSObject _) implements JSObject { /// constructor](/en-US/docs/Web/API/ReadableStream/ReadableStream#autoallocatechunksize) /// or when using a [ReadableStreamBYOBReader] (typically constructed by calling /// [ReadableStream.getReader] with the argument `{ mode: 'byob' }`). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBRequest). extension type ReadableStreamBYOBRequest._(JSObject _) implements JSObject { /// The **`respond()`** method of the [ReadableStreamBYOBRequest] interface is /// used to signal to the associated @@ -584,6 +614,11 @@ extension type ReadableStreamBYOBRequest._(JSObject _) implements JSObject { /// /// `WritableStream` is a /// [transferable object](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WritableStream). extension type WritableStream._(JSObject _) implements JSObject { external factory WritableStream([ JSObject underlyingSink, @@ -639,6 +674,11 @@ extension type UnderlyingSink._(JSObject _) implements JSObject { /// is the object returned by [WritableStream.getWriter] and once created locks /// the writer to the `WritableStream` ensuring that no other streams can write /// to the underlying sink. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultWriter). extension type WritableStreamDefaultWriter._(JSObject _) implements JSObject { external factory WritableStreamDefaultWriter(WritableStream stream); @@ -695,6 +735,11 @@ extension type WritableStreamDefaultWriter._(JSObject _) implements JSObject { /// represents a controller allowing control of a [WritableStream]'s state. When /// constructing a `WritableStream`, the underlying sink is given a /// corresponding `WritableStreamDefaultController` instance to manipulate. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultController). extension type WritableStreamDefaultController._(JSObject _) implements JSObject { /// The **`error()`** method of the @@ -729,6 +774,11 @@ extension type WritableStreamDefaultController._(JSObject _) /// /// `TransformStream` is a /// [transferable object](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TransformStream). extension type TransformStream._(JSObject _) implements JSObject { external factory TransformStream([ JSObject transformer, @@ -773,6 +823,11 @@ extension type Transformer._(JSObject _) implements JSObject { /// constructor. The way to get an instance of /// `TransformStreamDefaultController` is via the callback methods of /// [TransformStream.TransformStream]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TransformStreamDefaultController). extension type TransformStreamDefaultController._(JSObject _) implements JSObject { /// The **`enqueue()`** method of the [TransformStreamDefaultController] @@ -816,6 +871,11 @@ extension type QueuingStrategyInit._(JSObject _) implements JSObject { /// [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) /// provides a built-in byte length queuing strategy that can be used when /// constructing streams. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ByteLengthQueuingStrategy). extension type ByteLengthQueuingStrategy._(JSObject _) implements JSObject { external factory ByteLengthQueuingStrategy(QueuingStrategyInit init); @@ -827,6 +887,11 @@ extension type ByteLengthQueuingStrategy._(JSObject _) implements JSObject { /// [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) /// provides a built-in chunk counting queuing strategy that can be used when /// constructing streams. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CountQueuingStrategy). extension type CountQueuingStrategy._(JSObject _) implements JSObject { external factory CountQueuingStrategy(QueuingStrategyInit init); diff --git a/lib/src/dom/svg.dart b/lib/src/dom/svg.dart index d2dadc18..6927685e 100644 --- a/lib/src/dom/svg.dart +++ b/lib/src/dom/svg.dart @@ -22,6 +22,11 @@ import 'web_animations.dart'; /// All of the SVG DOM interfaces that correspond directly to elements in the /// SVG language derive from the `SVGElement` interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGElement). extension type SVGElement._(JSObject _) implements Element, JSObject { external void focus([FocusOptions options]); external void blur(); @@ -264,6 +269,11 @@ extension type SVGBoundingBoxOptions._(JSObject _) implements JSObject { /// The **`SVGGraphicsElement`** interface represents SVG elements whose primary /// purpose is to directly render graphics into a group. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGGraphicsElement). extension type SVGGraphicsElement._(JSObject _) implements SVGElement, JSObject { /// The **`SVGGraphicsElement.getBBox()`** method allows us to determine @@ -293,6 +303,11 @@ extension type SVGGraphicsElement._(JSObject _) /// The `SVGGeometryElement` interface represents SVG elements whose rendering /// is defined by geometry with an equivalent path, and which can be filled and /// stroked. This includes paths and the basic shapes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGGeometryElement). extension type SVGGeometryElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// The **`SVGGeometryElement.isPointInFill()`** method determines @@ -331,12 +346,22 @@ extension type SVGGeometryElement._(JSObject _) /// /// An `SVGNumber` object can be designated as read only, which means that /// attempts to modify the object will result in an exception being thrown. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGNumber). extension type SVGNumber._(JSObject _) implements JSObject { external set value(num value); external num get value; } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGLength). extension type SVGLength._(JSObject _) implements JSObject { external static int get SVG_LENGTHTYPE_UNKNOWN; external static int get SVG_LENGTHTYPE_NUMBER; @@ -381,6 +406,11 @@ extension type SVGLength._(JSObject _) implements JSObject { /// exposed through the `baseVal` member of an [SVGAnimatedAngle]), /// 2. **_Be detached_,** which is the case for `SVGAngle` objects created with /// [SVGSVGElement.createSVGAngle]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAngle). extension type SVGAngle._(JSObject _) implements JSObject { external static int get SVG_ANGLETYPE_UNKNOWN; external static int get SVG_ANGLETYPE_UNSPECIFIED; @@ -402,6 +432,11 @@ extension type SVGAngle._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGNumberList). extension type SVGNumberList._(JSObject _) implements JSObject { external void clear(); external SVGNumber initialize(SVGNumber newItem); @@ -421,6 +456,11 @@ extension type SVGNumberList._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGLengthList). extension type SVGLengthList._(JSObject _) implements JSObject { external void clear(); external SVGLength initialize(SVGLength newItem); @@ -440,6 +480,11 @@ extension type SVGLengthList._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGStringList). extension type SVGStringList._(JSObject _) implements JSObject { external void clear(); external String initialize(String newItem); @@ -459,6 +504,11 @@ extension type SVGStringList._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedBoolean). extension type SVGAnimatedBoolean._(JSObject _) implements JSObject { external set baseVal(bool value); external bool get baseVal; @@ -467,6 +517,11 @@ extension type SVGAnimatedBoolean._(JSObject _) implements JSObject { /// The **`SVGAnimatedEnumeration`** interface describes attribute values which /// are constants from a particular enumeration and which can be animated. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedEnumeration). extension type SVGAnimatedEnumeration._(JSObject _) implements JSObject { external set baseVal(int value); external int get baseVal; @@ -474,6 +529,11 @@ extension type SVGAnimatedEnumeration._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedInteger). extension type SVGAnimatedInteger._(JSObject _) implements JSObject { external set baseVal(int value); external int get baseVal; @@ -481,6 +541,11 @@ extension type SVGAnimatedInteger._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedNumber). extension type SVGAnimatedNumber._(JSObject _) implements JSObject { external set baseVal(num value); external num get baseVal; @@ -489,12 +554,22 @@ extension type SVGAnimatedNumber._(JSObject _) implements JSObject { /// The **`SVGAnimatedLength`** interface represents attributes of type /// [\](/en-US/docs/Web/SVG/Content_type#length) which can be animated. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedLength). extension type SVGAnimatedLength._(JSObject _) implements JSObject { external SVGLength get baseVal; external SVGLength get animVal; } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedAngle). extension type SVGAnimatedAngle._(JSObject _) implements JSObject { external SVGAngle get baseVal; external SVGAngle get animVal; @@ -503,6 +578,11 @@ extension type SVGAnimatedAngle._(JSObject _) implements JSObject { /// The **`SVGAnimatedString`** interface represents string attributes which can /// be animated from each SVG declaration. You need to create SVG attribute /// before doing anything else, everything should be declared inside this. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedString). extension type SVGAnimatedString._(JSObject _) implements JSObject { external set baseVal(String value); external String get baseVal; @@ -548,18 +628,33 @@ extension type SVGAnimatedString._(JSObject _) implements JSObject { /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedRect). extension type SVGAnimatedRect._(JSObject _) implements JSObject { external DOMRect get baseVal; external DOMRectReadOnly get animVal; } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedNumberList). extension type SVGAnimatedNumberList._(JSObject _) implements JSObject { external SVGNumberList get baseVal; external SVGNumberList get animVal; } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedLengthList). extension type SVGAnimatedLengthList._(JSObject _) implements JSObject { external SVGLengthList get baseVal; external SVGLengthList get animVal; @@ -568,6 +663,11 @@ extension type SVGAnimatedLengthList._(JSObject _) implements JSObject { /// The **`SVGUnitTypes`** interface defines a commonly used set of constants /// used for reflecting `gradientUnits`, `patternContentUnits` and other similar /// attributes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGUnitTypes). extension type SVGUnitTypes._(JSObject _) implements JSObject { external static int get SVG_UNIT_TYPE_UNKNOWN; external static int get SVG_UNIT_TYPE_USERSPACEONUSE; @@ -579,6 +679,11 @@ extension type SVGUnitTypes._(JSObject _) implements JSObject { /// also various miscellaneous commonly-used utility methods, such as matrix /// operations and the ability to control the time of redraw on visual rendering /// devices. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGSVGElement). extension type SVGSVGElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGSVGElement] using the tag 'svg'. @@ -673,6 +778,11 @@ extension type SVGSVGElement._(JSObject _) } /// The **`SVGGElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGGElement). extension type SVGGElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGGElement] using the tag 'g'. @@ -684,6 +794,11 @@ extension type SVGGElement._(JSObject _) } /// The **`SVGDefsElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGDefsElement). extension type SVGDefsElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGDefsElement] using the tag 'defs'. @@ -695,6 +810,11 @@ extension type SVGDefsElement._(JSObject _) } /// The **`SVGDescElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGDescElement). extension type SVGDescElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGDescElement] using the tag 'desc'. SVGDescElement() @@ -705,6 +825,11 @@ extension type SVGDescElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGMetadataElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGMetadataElement). extension type SVGMetadataElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGMetadataElement] using the tag 'metadata'. @@ -716,6 +841,11 @@ extension type SVGMetadataElement._(JSObject _) } /// The **`SVGTitleElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTitleElement). extension type SVGTitleElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGTitleElement] using the tag 'title'. SVGTitleElement() @@ -726,6 +856,11 @@ extension type SVGTitleElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGSymbolElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGSymbolElement). extension type SVGSymbolElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGSymbolElement] using the tag 'symbol'. @@ -740,6 +875,11 @@ extension type SVGSymbolElement._(JSObject _) } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGUseElement). extension type SVGUseElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGUseElement] using the tag 'use'. @@ -769,6 +909,11 @@ extension type ShadowAnimation._(JSObject _) implements Animation, JSObject { } /// The **`SVGSwitchElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGSwitchElement). extension type SVGSwitchElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGSwitchElement] using the tag 'switch'. @@ -780,6 +925,11 @@ extension type SVGSwitchElement._(JSObject _) } /// The **`SVGStyleElement`** interface corresponds to the SVG element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGStyleElement). extension type SVGStyleElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGStyleElement] using the tag 'style'. SVGStyleElement() @@ -798,6 +948,11 @@ extension type SVGStyleElement._(JSObject _) implements SVGElement, JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTransform). extension type SVGTransform._(JSObject _) implements JSObject { external static int get SVG_TRANSFORM_UNKNOWN; external static int get SVG_TRANSFORM_MATRIX; @@ -828,6 +983,11 @@ extension type SVGTransform._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTransformList). extension type SVGTransformList._(JSObject _) implements JSObject { external void clear(); external SVGTransform initialize(SVGTransform newItem); @@ -849,12 +1009,22 @@ extension type SVGTransformList._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedTransformList). extension type SVGAnimatedTransformList._(JSObject _) implements JSObject { external SVGTransformList get baseVal; external SVGTransformList get animVal; } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGPreserveAspectRatio). extension type SVGPreserveAspectRatio._(JSObject _) implements JSObject { external static int get SVG_PRESERVEASPECTRATIO_UNKNOWN; external static int get SVG_PRESERVEASPECTRATIO_NONE; @@ -877,6 +1047,11 @@ extension type SVGPreserveAspectRatio._(JSObject _) implements JSObject { } /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimatedPreserveAspectRatio). extension type SVGAnimatedPreserveAspectRatio._(JSObject _) implements JSObject { external SVGPreserveAspectRatio get baseVal; @@ -889,6 +1064,11 @@ extension type SVGAnimatedPreserveAspectRatio._(JSObject _) /// > methods were removed and the `pathLength` property and the /// > `getTotalLength()` and `getPointAtLength()` methods were moved to /// > [SVGGeometryElement]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGPathElement). extension type SVGPathElement._(JSObject _) implements SVGGeometryElement, JSObject { /// Creates an [SVGPathElement] using the tag 'path'. @@ -901,6 +1081,11 @@ extension type SVGPathElement._(JSObject _) /// The `SVGRectElement` interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGRectElement). extension type SVGRectElement._(JSObject _) implements SVGGeometryElement, JSObject { /// Creates an [SVGRectElement] using the tag 'rect'. @@ -919,6 +1104,11 @@ extension type SVGRectElement._(JSObject _) } /// The **`SVGCircleElement`** interface is an interface for the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGCircleElement). extension type SVGCircleElement._(JSObject _) implements SVGGeometryElement, JSObject { /// Creates an [SVGCircleElement] using the tag 'circle'. @@ -935,6 +1125,11 @@ extension type SVGCircleElement._(JSObject _) /// The **`SVGEllipseElement`** interface provides access to the properties of /// elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGEllipseElement). extension type SVGEllipseElement._(JSObject _) implements SVGGeometryElement, JSObject { /// Creates an [SVGEllipseElement] using the tag 'ellipse'. @@ -952,6 +1147,11 @@ extension type SVGEllipseElement._(JSObject _) /// The **`SVGLineElement`** interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGLineElement). extension type SVGLineElement._(JSObject _) implements SVGGeometryElement, JSObject { /// Creates an [SVGLineElement] using the tag 'line'. @@ -971,6 +1171,11 @@ extension type SVGLineElement._(JSObject _) /// /// An `SVGPointList` can be designated as read-only, which means that attempts /// to modify the object will result in an exception being thrown. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGPointList). extension type SVGPointList._(JSObject _) implements JSObject { /// The **`clear()`** method of the [SVGPointList] interface removes all items /// from the list. @@ -1011,6 +1216,11 @@ extension type SVGPointList._(JSObject _) implements JSObject { /// The **`SVGPolylineElement`** interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGPolylineElement). extension type SVGPolylineElement._(JSObject _) implements SVGGeometryElement, JSObject { /// Creates an [SVGPolylineElement] using the tag 'polyline'. @@ -1026,6 +1236,11 @@ extension type SVGPolylineElement._(JSObject _) /// The **`SVGPolygonElement`** interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGPolygonElement). extension type SVGPolygonElement._(JSObject _) implements SVGGeometryElement, JSObject { /// Creates an [SVGPolygonElement] using the tag 'polygon'. @@ -1043,6 +1258,11 @@ extension type SVGPolygonElement._(JSObject _) /// support rendering child text content. It is inherited by various /// text-related interfaces, such as [SVGTextElement], [SVGTSpanElement], /// [SVGTRefElement], and [SVGTextPathElement]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTextContentElement). extension type SVGTextContentElement._(JSObject _) implements SVGGraphicsElement, JSObject { external static int get LENGTHADJUST_UNKNOWN; @@ -1070,6 +1290,11 @@ extension type SVGTextContentElement._(JSObject _) /// The **`SVGTextPositioningElement`** interface is implemented by elements /// that support attributes that position individual text glyphs. It is /// inherited by [SVGTextElement], [SVGTSpanElement], and [SVGTRefElement]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTextPositioningElement). extension type SVGTextPositioningElement._(JSObject _) implements SVGTextContentElement, JSObject { external SVGAnimatedLengthList get x; @@ -1080,6 +1305,11 @@ extension type SVGTextPositioningElement._(JSObject _) } /// The **`SVGTextElement`** interface corresponds to the elements. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTextElement). extension type SVGTextElement._(JSObject _) implements SVGTextPositioningElement, JSObject { /// Creates an [SVGTextElement] using the tag 'text'. @@ -1091,6 +1321,11 @@ extension type SVGTextElement._(JSObject _) } /// The **`SVGTSpanElement`** interface represents a element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTSpanElement). extension type SVGTSpanElement._(JSObject _) implements SVGTextPositioningElement, JSObject { /// Creates an [SVGTSpanElement] using the tag 'tspan'. @@ -1102,6 +1337,11 @@ extension type SVGTSpanElement._(JSObject _) } /// The **`SVGTextPathElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGTextPathElement). extension type SVGTextPathElement._(JSObject _) implements SVGTextContentElement, JSObject { /// Creates an [SVGTextPathElement] using the tag 'textPath'. @@ -1124,6 +1364,11 @@ extension type SVGTextPathElement._(JSObject _) } /// The **`SVGImageElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGImageElement). extension type SVGImageElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGImageElement] using the tag 'image'. @@ -1145,6 +1390,11 @@ extension type SVGImageElement._(JSObject _) /// The **`SVGForeignObjectElement`** interface provides access to the /// properties of elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGForeignObjectElement). extension type SVGForeignObjectElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGForeignObjectElement] using the tag 'foreignObject'. @@ -1166,6 +1416,11 @@ extension type SVGForeignObjectElement._(JSObject _) /// /// The following properties and methods all return, or act on the attributes of /// the element represented by `SVGMarkerElement`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGMarkerElement). extension type SVGMarkerElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGMarkerElement] using the tag 'marker'. SVGMarkerElement() @@ -1204,6 +1459,11 @@ extension type SVGMarkerElement._(JSObject _) implements SVGElement, JSObject { /// The **`SVGGradient`** interface is a base interface used by /// [SVGLinearGradientElement] and [SVGRadialGradientElement]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGGradientElement). extension type SVGGradientElement._(JSObject _) implements SVGElement, JSObject { external static int get SVG_SPREADMETHOD_UNKNOWN; @@ -1217,6 +1477,11 @@ extension type SVGGradientElement._(JSObject _) } /// The **`SVGLinearGradientElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGLinearGradientElement). extension type SVGLinearGradientElement._(JSObject _) implements SVGGradientElement, JSObject { /// Creates an [SVGLinearGradientElement] using the tag 'linearGradient'. @@ -1233,6 +1498,11 @@ extension type SVGLinearGradientElement._(JSObject _) } /// The **`SVGRadialGradientElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGRadialGradientElement). extension type SVGRadialGradientElement._(JSObject _) implements SVGGradientElement, JSObject { /// Creates an [SVGRadialGradientElement] using the tag 'radialGradient'. @@ -1251,6 +1521,11 @@ extension type SVGRadialGradientElement._(JSObject _) } /// The **`SVGStopElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGStopElement). extension type SVGStopElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGStopElement] using the tag 'stop'. SVGStopElement() @@ -1263,6 +1538,11 @@ extension type SVGStopElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGPatternElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGPatternElement). extension type SVGPatternElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGPatternElement] using the tag 'pattern'. SVGPatternElement() @@ -1284,6 +1564,11 @@ extension type SVGPatternElement._(JSObject _) implements SVGElement, JSObject { } /// The **`SVGScriptElement`** interface corresponds to the SVG element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGScriptElement). extension type SVGScriptElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGScriptElement] using the tag 'script'. SVGScriptElement() @@ -1301,6 +1586,11 @@ extension type SVGScriptElement._(JSObject _) implements SVGElement, JSObject { /// The **`SVGAElement`** interface provides access to the properties of an /// element, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAElement). extension type SVGAElement._(JSObject _) implements SVGGraphicsElement, JSObject { /// Creates an [SVGAElement] using the tag 'a'. @@ -1350,6 +1640,11 @@ extension type SVGAElement._(JSObject _) /// The **`SVGViewElement`** interface provides access to the properties of /// elements, as well as methods to manipulate them. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGViewElement). extension type SVGViewElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGViewElement] using the tag 'view'. SVGViewElement() diff --git a/lib/src/dom/svg_animations.dart b/lib/src/dom/svg_animations.dart index e53e5083..378990af 100644 --- a/lib/src/dom/svg_animations.dart +++ b/lib/src/dom/svg_animations.dart @@ -21,6 +21,11 @@ import 'svg.dart'; /// [SVG SMIL](https://developer.mozilla.org/en-US/docs/Web/SVG/SVG_animation_with_SMIL) /// animation, provides specific contextual information associated with Time /// events. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TimeEvent). extension type TimeEvent._(JSObject _) implements Event, JSObject { external void initTimeEvent( String typeArg, @@ -35,6 +40,11 @@ extension type TimeEvent._(JSObject _) implements Event, JSObject { /// animation element interfaces: [SVGAnimateElement], [SVGSetElement], /// [SVGAnimateColorElement], [SVGAnimateMotionElement] and /// [SVGAnimateTransformElement]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimationElement). extension type SVGAnimationElement._(JSObject _) implements SVGElement, JSObject { external num getStartTime(); @@ -56,6 +66,11 @@ extension type SVGAnimationElement._(JSObject _) } /// The **`SVGAnimateElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimateElement). extension type SVGAnimateElement._(JSObject _) implements SVGAnimationElement, JSObject { /// Creates an [SVGAnimateElement] using the tag 'animate'. @@ -67,6 +82,11 @@ extension type SVGAnimateElement._(JSObject _) } /// The **`SVGSetElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGSetElement). extension type SVGSetElement._(JSObject _) implements SVGAnimationElement, JSObject { /// Creates an [SVGSetElement] using the tag 'set'. @@ -78,6 +98,11 @@ extension type SVGSetElement._(JSObject _) } /// The **`SVGAnimateMotionElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimateMotionElement). extension type SVGAnimateMotionElement._(JSObject _) implements SVGAnimationElement, JSObject { /// Creates an [SVGAnimateMotionElement] using the tag 'animateMotion'. @@ -89,6 +114,11 @@ extension type SVGAnimateMotionElement._(JSObject _) } /// The **`SVGMPathElement`** interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGMPathElement). extension type SVGMPathElement._(JSObject _) implements SVGElement, JSObject { /// Creates an [SVGMPathElement] using the tag 'mpath'. SVGMPathElement() @@ -101,6 +131,11 @@ extension type SVGMPathElement._(JSObject _) implements SVGElement, JSObject { } /// The `SVGAnimateTransformElement` interface corresponds to the element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SVGAnimateTransformElement). extension type SVGAnimateTransformElement._(JSObject _) implements SVGAnimationElement, JSObject { /// Creates an [SVGAnimateTransformElement] using the tag 'animateTransform'. diff --git a/lib/src/dom/touch_events.dart b/lib/src/dom/touch_events.dart index ad5ab32e..87b2f90d 100644 --- a/lib/src/dom/touch_events.dart +++ b/lib/src/dom/touch_events.dart @@ -84,6 +84,11 @@ extension type TouchInit._(JSObject _) implements JSObject { /// > placed on the surface, the `force` value will always be 0. This may also /// > be the case for `radiusX` and `radiusY`; if the hardware reports only a /// > single point, these values will be 1. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Touch). extension type Touch._(JSObject _) implements JSObject { external factory Touch(TouchInit touchInitDict); @@ -116,6 +121,11 @@ extension type Touch._(JSObject _) implements JSObject { /// > so you can treat them like ECMAScript arrays, and at the same time impose /// > additional semantics on their usage (such as making their items /// > read-only). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TouchList). extension type TouchList._(JSObject _) implements JSObject { /// The **`item()`** method returns the [Touch] /// object at the specified index in the [TouchList]. @@ -167,6 +177,11 @@ extension type TouchEventInit._(JSObject _) /// Touches are represented by the [Touch] object; each touch is described by a /// position, size and shape, amount of pressure, and target element. Lists of /// touches are represented by [TouchList] objects. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent). extension type TouchEvent._(JSObject _) implements UIEvent, JSObject { external factory TouchEvent( String type, [ diff --git a/lib/src/dom/trusted_types.dart b/lib/src/dom/trusted_types.dart index f20b324a..6360c1fb 100644 --- a/lib/src/dom/trusted_types.dart +++ b/lib/src/dom/trusted_types.dart @@ -29,6 +29,11 @@ typedef CreateScriptURLCallback = JSFunction; /// /// The value of a **TrustedHTML** object is set when the object is created and /// cannot be changed by JavaScript as there is no setter exposed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TrustedHTML). extension type TrustedHTML._(JSObject _) implements JSObject { external static TrustedHTML fromLiteral(JSObject templateStringsArray); @@ -45,6 +50,11 @@ extension type TrustedHTML._(JSObject _) implements JSObject { /// /// The value of a **TrustedScript** object is set when the object is created /// and cannot be changed by JavaScript as there is no setter exposed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TrustedScript). extension type TrustedScript._(JSObject _) implements JSObject { external static TrustedScript fromLiteral(JSObject templateStringsArray); @@ -61,6 +71,11 @@ extension type TrustedScript._(JSObject _) implements JSObject { /// /// The value of a **TrustedScriptURL** object is set when the object is created /// and cannot be changed by JavaScript as there is no setter exposed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TrustedScriptURL). extension type TrustedScriptURL._(JSObject _) implements JSObject { external static TrustedScriptURL fromLiteral(JSObject templateStringsArray); @@ -72,6 +87,11 @@ extension type TrustedScriptURL._(JSObject _) implements JSObject { /// The **`TrustedTypePolicyFactory`** interface of the [Trusted Types API] /// creates policies and allows the verification of Trusted Type objects against /// created policies. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TrustedTypePolicyFactory). extension type TrustedTypePolicyFactory._(JSObject _) implements JSObject { /// The **`createPolicy()`** method of the [TrustedTypePolicyFactory] /// interface creates a [TrustedTypePolicy] object that implements the rules @@ -151,6 +171,11 @@ extension type TrustedTypePolicyFactory._(JSObject _) implements JSObject { /// A `TrustedTypePolicy` object is created by /// [TrustedTypePolicyFactory.createPolicy] to define a policy for enforcing /// security rules on input. Therefore, `TrustedTypePolicy` has no constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/TrustedTypePolicy). extension type TrustedTypePolicy._(JSObject _) implements JSObject { /// The **`createHTML()`** method of the [TrustedTypePolicy] interface creates /// a [TrustedHTML] object using a policy created by diff --git a/lib/src/dom/uievents.dart b/lib/src/dom/uievents.dart index 8ec29077..ae23e097 100644 --- a/lib/src/dom/uievents.dart +++ b/lib/src/dom/uievents.dart @@ -25,6 +25,11 @@ import 'html.dart'; /// Several interfaces are direct or indirect descendants of this one: /// [MouseEvent], [TouchEvent], [FocusEvent], [KeyboardEvent], [WheelEvent], /// [InputEvent], and [CompositionEvent]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/UIEvent). extension type UIEvent._(JSObject _) implements Event, JSObject { external factory UIEvent( String type, [ @@ -77,6 +82,11 @@ extension type UIEventInit._(JSObject _) implements EventInit, JSObject { /// The **`FocusEvent`** interface represents focus-related events, including /// [Element/focus_event], [Element/blur_event], [Element/focusin_event], and /// [Element/focusout_event]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent). extension type FocusEvent._(JSObject _) implements UIEvent, JSObject { external factory FocusEvent( String type, [ @@ -113,6 +123,11 @@ extension type FocusEventInit._(JSObject _) implements UIEventInit, JSObject { /// /// Several more specific events are based on `MouseEvent`, including /// [WheelEvent], [DragEvent], and [PointerEvent]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent). extension type MouseEvent._(JSObject _) implements UIEvent, JSObject { external factory MouseEvent( String type, [ @@ -297,6 +312,11 @@ extension type EventModifierInit._(JSObject _) /// > content's scrolling direction. Instead, detect value changes to /// > [Element.scrollLeft] and [Element.scrollTop] of the target in the `scroll` /// > event. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent). extension type WheelEvent._(JSObject _) implements MouseEvent, JSObject { external factory WheelEvent( String type, [ @@ -359,6 +379,11 @@ extension type WheelEventInit._(JSObject _) /// The **`InputEvent`** interface represents an event notifying the user of /// editable content changes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/InputEvent). extension type InputEvent._(JSObject _) implements UIEvent, JSObject { external factory InputEvent( String type, [ @@ -402,6 +427,11 @@ extension type InputEventInit._(JSObject _) implements UIEventInit, JSObject { /// > [Element/input_event] event instead. Keyboard events may not be fired if /// > the user is using an alternate means of entering text, such as a /// > handwriting system on a tablet or graphics tablet. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent). extension type KeyboardEvent._(JSObject _) implements UIEvent, JSObject { external factory KeyboardEvent( String type, [ @@ -501,6 +531,11 @@ extension type KeyboardEventInit._(JSObject _) /// The DOM **`CompositionEvent`** represents events that occur due to the user /// indirectly entering text. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CompositionEvent). extension type CompositionEvent._(JSObject _) implements UIEvent, JSObject { external factory CompositionEvent( String type, [ @@ -558,6 +593,11 @@ extension type CompositionEventInit._(JSObject _) /// > They have been deprecated in favor of /// > [mutation observers](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver). /// > **Consider using these instead.** +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MutationEvent). extension type MutationEvent._(JSObject _) implements Event, JSObject { external static int get MODIFICATION; external static int get ADDITION; diff --git a/lib/src/dom/url.dart b/lib/src/dom/url.dart index eb8baf64..f05341b7 100644 --- a/lib/src/dom/url.dart +++ b/lib/src/dom/url.dart @@ -25,6 +25,11 @@ import 'dart:js_interop'; /// If a browser doesn't yet support the [URL.URL] constructor, you can access a /// URL object using the [Window] interface's [URL] property. Be sure to check /// to see if any of your target browsers require this to be prefixed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/URL). extension type URL._(JSObject _) implements JSObject { external factory URL( String url, [ @@ -81,6 +86,11 @@ extension type URL._(JSObject _) implements JSObject { /// for (const [key, value] of mySearchParams.entries()) { /// } /// ``` +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams). extension type URLSearchParams._(JSObject _) implements JSObject { external factory URLSearchParams([JSAny init]); diff --git a/lib/src/dom/user_timing.dart b/lib/src/dom/user_timing.dart index f82a9318..b2630193 100644 --- a/lib/src/dom/user_timing.dart +++ b/lib/src/dom/user_timing.dart @@ -52,6 +52,11 @@ extension type PerformanceMeasureOptions._(JSObject _) implements JSObject { /// add a _named_ [DOMHighResTimeStamp] (the _mark_) to the browser's /// performance timeline. To create a performance mark that isn't added to the /// browser's performance timeline, use the constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceMark). extension type PerformanceMark._(JSObject _) implements PerformanceEntry, JSObject { external factory PerformanceMark( @@ -67,6 +72,11 @@ extension type PerformanceMark._(JSObject _) /// type are created by calling [Performance.measure] to add a _named_ /// [DOMHighResTimeStamp] (the _measure_) between two _marks_ to the browser's /// _performance timeline_. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceMeasure). extension type PerformanceMeasure._(JSObject _) implements PerformanceEntry, JSObject { external JSAny? get detail; diff --git a/lib/src/dom/web_animations.dart b/lib/src/dom/web_animations.dart index 1da558b4..7f50a214 100644 --- a/lib/src/dom/web_animations.dart +++ b/lib/src/dom/web_animations.dart @@ -34,6 +34,11 @@ typedef CompositeOperationOrAuto = String; /// - [DocumentTimeline] /// - [ScrollTimeline] /// - [ViewTimeline] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AnimationTimeline). extension type AnimationTimeline._(JSObject _) implements JSObject { external Animation play([AnimationEffect? effect]); external CSSNumberish? get currentTime; @@ -50,6 +55,11 @@ extension type DocumentTimelineOptions._(JSObject _) implements JSObject { /// [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) /// represents animation timelines, including the default document timeline /// (accessed via [Document.timeline]). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DocumentTimeline). extension type DocumentTimeline._(JSObject _) implements AnimationTimeline, JSObject { external factory DocumentTimeline([DocumentTimelineOptions options]); @@ -59,6 +69,11 @@ extension type DocumentTimeline._(JSObject _) /// [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) /// represents a single animation player and provides playback controls and a /// timeline for an animation node or source. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Animation). extension type Animation._(JSObject _) implements EventTarget, JSObject { external factory Animation([ AnimationEffect? effect, @@ -193,6 +208,11 @@ extension type Animation._(JSObject _) implements EventTarget, JSObject { /// [CSS Animations](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_animations) /// and /// [Transitions](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AnimationEffect). extension type AnimationEffect._(JSObject _) implements JSObject { external void before(AnimationEffect effects); external void after(AnimationEffect effects); @@ -330,6 +350,11 @@ extension type ComputedEffectTiming._(JSObject _) /// lets us create sets of animatable properties and values, called /// **keyframes.** These can then be played using the [Animation.Animation] /// constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect). extension type KeyframeEffect._(JSObject _) implements AnimationEffect, JSObject { external factory KeyframeEffect( diff --git a/lib/src/dom/web_animations_2.dart b/lib/src/dom/web_animations_2.dart index 209221f9..541b14af 100644 --- a/lib/src/dom/web_animations_2.dart +++ b/lib/src/dom/web_animations_2.dart @@ -62,6 +62,11 @@ extension type TimelineRangeOffset._(JSObject _) implements JSObject { /// /// As animations play, they report changes to their [Animation.playState] /// through animation events. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AnimationPlaybackEvent). extension type AnimationPlaybackEvent._(JSObject _) implements Event, JSObject { external factory AnimationPlaybackEvent( String type, [ diff --git a/lib/src/dom/web_locks.dart b/lib/src/dom/web_locks.dart index e06cca66..432fd1cb 100644 --- a/lib/src/dom/web_locks.dart +++ b/lib/src/dom/web_locks.dart @@ -23,6 +23,11 @@ typedef LockMode = String; /// provides methods for requesting a new [Lock] object and querying for an /// existing `Lock` object. To get an instance of `LockManager`, call /// [navigator.locks]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/LockManager). extension type LockManager._(JSObject _) implements JSObject { /// The **`request()`** method of the [LockManager] interface requests a /// [Lock] object with parameters specifying its name and characteristics. @@ -115,6 +120,11 @@ extension type LockInfo._(JSObject _) implements JSObject { /// This may be a newly requested lock that is received in the callback to /// [LockManager.request], or a record of an active or queued lock returned by /// [LockManager.query]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Lock). extension type Lock._(JSObject _) implements JSObject { external String get name; external LockMode get mode; diff --git a/lib/src/dom/webaudio.dart b/lib/src/dom/webaudio.dart index ad0981ab..e61a03f3 100644 --- a/lib/src/dom/webaudio.dart +++ b/lib/src/dom/webaudio.dart @@ -44,6 +44,11 @@ typedef OverSampleType = String; /// /// A `BaseAudioContext` can be a target of events, therefore it implements the /// [EventTarget] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/BaseAudioContext). extension type BaseAudioContext._(JSObject _) implements EventTarget, JSObject { /// The `createAnalyser()` method of the /// [BaseAudioContext] interface creates an [AnalyserNode], which @@ -314,6 +319,11 @@ extension type BaseAudioContext._(JSObject _) implements EventTarget, JSObject { /// context. It's recommended to create one AudioContext and reuse it instead of /// initializing a new one each time, and it's OK to use a single `AudioContext` /// for several different audio sources and pipeline concurrently. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioContext). extension type AudioContext._(JSObject _) implements BaseAudioContext, JSObject { external factory AudioContext([AudioContextOptions contextOptions]); @@ -467,6 +477,11 @@ extension type AudioSinkOptions._(JSObject _) implements JSObject { /// The **`AudioSinkInfo`** interface of the [Web Audio API] represents /// information describing an [AudioContext]'s sink ID, retrieved via /// [AudioContext.sinkId]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioSinkInfo). extension type AudioSinkInfo._(JSObject _) implements JSObject { external AudioSinkType get type; } @@ -534,6 +549,11 @@ extension type AudioRenderCapacityEventInit._(JSObject _) /// `OfflineAudioContext` doesn't render the audio to the device hardware; /// instead, it generates it, as fast as it can, and outputs the result to an /// [AudioBuffer]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/OfflineAudioContext). extension type OfflineAudioContext._(JSObject _) implements BaseAudioContext, JSObject { external factory OfflineAudioContext( @@ -614,6 +634,11 @@ extension type OfflineAudioContextOptions._(JSObject _) implements JSObject { /// > for legacy reasons, but it will soon be superseded when the promise /// > version of [OfflineAudioContext.startRendering] is supported in browsers, /// > which will no longer need it. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/OfflineAudioCompletionEvent). extension type OfflineAudioCompletionEvent._(JSObject _) implements Event, JSObject { external factory OfflineAudioCompletionEvent( @@ -650,6 +675,11 @@ extension type OfflineAudioCompletionEventInit._(JSObject _) /// between `-1` and `+1`, that is, a 32-bit floating point buffer, with each /// sample between -1.0 and 1.0. If the [AudioBuffer] has multiple channels, /// they are stored in separate buffers. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer). extension type AudioBuffer._(JSObject _) implements JSObject { external factory AudioBuffer(AudioBufferOptions options); @@ -711,6 +741,11 @@ extension type AudioBufferOptions._(JSObject _) implements JSObject { /// /// > **Note:** An `AudioNode` can be target of events, therefore it implements /// > the [EventTarget] interface. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioNode). extension type AudioNode._(JSObject _) implements EventTarget, JSObject { /// The `connect()` method of the [AudioNode] interface lets /// you connect one of the node's outputs to a target, which may be either @@ -768,6 +803,11 @@ extension type AudioNodeOptions._(JSObject _) implements JSObject { /// schedule changes that have to happen at very precise times, using arbitrary /// timeline-based automation curves. The time used is the one defined in /// [BaseAudioContext/currentTime]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioParam). extension type AudioParam._(JSObject _) implements JSObject { /// The `setValueAtTime()` method of the /// [AudioParam] interface schedules an instant change to the @@ -866,6 +906,11 @@ extension type AudioParam._(JSObject _) implements JSObject { /// silence when not playing (that is, before `start()` is called and after /// `stop()` is called). Silence is represented, as always, by a stream of /// samples with the value zero (0). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioScheduledSourceNode). extension type AudioScheduledSourceNode._(JSObject _) implements AudioNode, JSObject { /// The `start()` method on @@ -926,6 +971,11 @@ extension type AudioScheduledSourceNode._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode). extension type AnalyserNode._(JSObject _) implements AudioNode, JSObject { external factory AnalyserNode( BaseAudioContext context, [ @@ -1058,6 +1108,11 @@ extension type AnalyserOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode). extension type AudioBufferSourceNode._(JSObject _) implements AudioScheduledSourceNode, JSObject { external factory AudioBufferSourceNode( @@ -1146,6 +1201,11 @@ extension type AudioBufferSourceOptions._(JSObject _) implements JSObject { /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioDestinationNode). extension type AudioDestinationNode._(JSObject _) implements AudioNode, JSObject { external int get maxChannelCount; @@ -1162,6 +1222,11 @@ extension type AudioDestinationNode._(JSObject _) /// /// ![We see the position, up and front vectors of an AudioListener, with the up /// and front vectors at 90° from the other.](webaudiolistenerreduced.png) +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioListener). extension type AudioListener._(JSObject _) implements JSObject { /// The `setPosition()` method of the [AudioListener] Interface defines the /// position of the listener. @@ -1228,6 +1293,11 @@ extension type AudioListener._(JSObject _) implements JSObject { /// /// > **Warning:** This feature has been deprecated and should be replaced by an /// > [`AudioWorklet`](https://developer.mozilla.org/en-US/docs/Web/API/AudioWorklet). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioProcessingEvent). extension type AudioProcessingEvent._(JSObject _) implements Event, JSObject { external factory AudioProcessingEvent( String type, @@ -1287,6 +1357,11 @@ extension type AudioProcessingEventInit._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode). extension type BiquadFilterNode._(JSObject _) implements AudioNode, JSObject { external factory BiquadFilterNode( BaseAudioContext context, [ @@ -1382,6 +1457,11 @@ extension type BiquadFilterOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ChannelMergerNode). extension type ChannelMergerNode._(JSObject _) implements AudioNode, JSObject { external factory ChannelMergerNode( BaseAudioContext context, [ @@ -1447,6 +1527,11 @@ extension type ChannelMergerOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ChannelSplitterNode). extension type ChannelSplitterNode._(JSObject _) implements AudioNode, JSObject { external factory ChannelSplitterNode( @@ -1491,6 +1576,11 @@ extension type ChannelSplitterOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ConstantSourceNode). extension type ConstantSourceNode._(JSObject _) implements AudioScheduledSourceNode, JSObject { external factory ConstantSourceNode( @@ -1539,6 +1629,11 @@ extension type ConstantSourceOptions._(JSObject _) implements JSObject { /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ConvolverNode). extension type ConvolverNode._(JSObject _) implements AudioNode, JSObject { external factory ConvolverNode( BaseAudioContext context, [ @@ -1605,6 +1700,11 @@ extension type ConvolverOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DelayNode). extension type DelayNode._(JSObject _) implements AudioNode, JSObject { external factory DelayNode( BaseAudioContext context, [ @@ -1660,6 +1760,11 @@ extension type DelayOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DynamicsCompressorNode). extension type DynamicsCompressorNode._(JSObject _) implements AudioNode, JSObject { external factory DynamicsCompressorNode( @@ -1736,6 +1841,11 @@ extension type DynamicsCompressorOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/GainNode). extension type GainNode._(JSObject _) implements AudioNode, JSObject { external factory GainNode( BaseAudioContext context, [ @@ -1808,6 +1918,11 @@ extension type GainOptions._(JSObject _) implements AudioNodeOptions, JSObject { /// continues forever, but this can be limited after some finite time in /// practice, when the output has approached zero closely enough. The actual /// time that takes depends on the filter coefficients provided. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/IIRFilterNode). extension type IIRFilterNode._(JSObject _) implements AudioNode, JSObject { external factory IIRFilterNode( BaseAudioContext context, @@ -1876,6 +1991,11 @@ extension type IIRFilterOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaElementAudioSourceNode). extension type MediaElementAudioSourceNode._(JSObject _) implements AudioNode, JSObject { external factory MediaElementAudioSourceNode( @@ -1927,6 +2047,11 @@ extension type MediaElementAudioSourceOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamAudioDestinationNode). extension type MediaStreamAudioDestinationNode._(JSObject _) implements AudioNode, JSObject { external factory MediaStreamAudioDestinationNode( @@ -1976,6 +2101,11 @@ extension type MediaStreamAudioDestinationNode._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamAudioSourceNode). extension type MediaStreamAudioSourceNode._(JSObject _) implements AudioNode, JSObject { external factory MediaStreamAudioSourceNode( @@ -2031,6 +2161,11 @@ extension type MediaStreamAudioSourceOptions._(JSObject _) implements JSObject { /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrackAudioSourceNode). extension type MediaStreamTrackAudioSourceNode._(JSObject _) implements AudioNode, JSObject { external factory MediaStreamTrackAudioSourceNode( @@ -2076,6 +2211,11 @@ extension type MediaStreamTrackAudioSourceOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode). extension type OscillatorNode._(JSObject _) implements AudioScheduledSourceNode, JSObject { external factory OscillatorNode( @@ -2153,6 +2293,11 @@ extension type OscillatorOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PannerNode). extension type PannerNode._(JSObject _) implements AudioNode, JSObject { external factory PannerNode( BaseAudioContext context, [ @@ -2288,6 +2433,11 @@ extension type PannerOptions._(JSObject _) /// oscillators when calling [OscillatorNode.setPeriodicWave]. The /// `PeriodicWave` itself is created/returned by /// [BaseAudioContext.createPeriodicWave]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PeriodicWave). extension type PeriodicWave._(JSObject _) implements JSObject { external factory PeriodicWave( BaseAudioContext context, [ @@ -2368,6 +2518,11 @@ extension type PeriodicWaveOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode). extension type ScriptProcessorNode._(JSObject _) implements AudioNode, JSObject { external set onaudioprocess(EventHandler value); @@ -2415,6 +2570,11 @@ extension type ScriptProcessorNode._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/StereoPannerNode). extension type StereoPannerNode._(JSObject _) implements AudioNode, JSObject { external factory StereoPannerNode( BaseAudioContext context, [ @@ -2468,6 +2628,11 @@ extension type StereoPannerOptions._(JSObject _) /// /// /// +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WaveShaperNode). extension type WaveShaperNode._(JSObject _) implements AudioNode, JSObject { external factory WaveShaperNode( BaseAudioContext context, [ @@ -2506,6 +2671,11 @@ extension type WaveShaperOptions._(JSObject _) /// /// Access the audio context's instance of `AudioWorklet` through the /// [BaseAudioContext.audioWorklet] property. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioWorklet). extension type AudioWorklet._(JSObject _) implements Worklet, JSObject { external MessagePort get port; } @@ -2523,6 +2693,11 @@ extension type AudioWorklet._(JSObject _) implements Worklet, JSObject { /// `BaseAudioContext`, it's possible to define any other variables and perform /// any actions allowed in worklets — apart from defining /// `AudioWorkletProcessor` derived classes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletGlobalScope). extension type AudioWorkletGlobalScope._(JSObject _) implements WorkletGlobalScope, JSObject { /// The **`registerProcessor`** method of the @@ -2547,6 +2722,11 @@ extension type AudioWorkletGlobalScope._(JSObject _) /// [`Map`-like object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map#map-like_browser_apis), /// in which each key is the name string for a parameter, and the corresponding /// value is an [AudioParam] containing the value of that parameter. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioParamMap). extension type AudioParamMap._(JSObject _) implements JSObject {} /// > **Note:** Although the interface is available outside @@ -2560,6 +2740,11 @@ extension type AudioParamMap._(JSObject _) implements JSObject {} /// connected to an audio routing graph along with other nodes. It has an /// associated [AudioWorkletProcessor], which does the actual audio processing /// in a Web Audio rendering thread. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletNode). extension type AudioWorkletNode._(JSObject _) implements AudioNode, JSObject { external factory AudioWorkletNode( BaseAudioContext context, @@ -2602,6 +2787,11 @@ extension type AudioWorkletNodeOptions._(JSObject _) /// represents an audio processing code behind a custom [AudioWorkletNode]. It /// lives in the [AudioWorkletGlobalScope] and runs on the Web Audio rendering /// thread. In turn, an [AudioWorkletNode] based on it runs on the main thread. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletProcessor). extension type AudioWorkletProcessor._(JSObject _) implements JSObject { external factory AudioWorkletProcessor(); @@ -2618,6 +2808,11 @@ extension type AudioWorkletProcessor._(JSObject _) implements JSObject { /// returned array of objects based on this dictionary is used internally by /// `AudioWorkletNode` constructor to populate its [AudioWorkletNode.parameters] /// property accordingly. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AudioParamDescriptor). extension type AudioParamDescriptor._(JSObject _) implements JSObject { external factory AudioParamDescriptor({ required String name, diff --git a/lib/src/dom/webauthn.dart b/lib/src/dom/webauthn.dart index 1207188b..0c5443e0 100644 --- a/lib/src/dom/webauthn.dart +++ b/lib/src/dom/webauthn.dart @@ -43,6 +43,11 @@ typedef LargeBlobSupport = String; /// /// > **Note:** This API is restricted to top-level contexts. Use from within an /// > `iframe` element will not have any effect. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential). extension type PublicKeyCredential._(JSObject _) implements Credential, JSObject { /// The **`isConditionalMediationAvailable()`** static method of the @@ -333,6 +338,11 @@ extension type PublicKeyCredentialRequestOptionsJSON._(JSObject _) /// trust for a key pair. The child interfaces include information from the /// browser such as the challenge origin and either may be returned from /// [PublicKeyCredential.response]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorResponse). extension type AuthenticatorResponse._(JSObject _) implements JSObject { external JSArrayBuffer get clientDataJSON; } @@ -351,6 +361,11 @@ extension type AuthenticatorResponse._(JSObject _) implements JSObject { /// /// > **Note:** This interface is restricted to top-level contexts. Use of its /// > features from within an `iframe` element will not have any effect. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAttestationResponse). extension type AuthenticatorAttestationResponse._(JSObject _) implements AuthenticatorResponse, JSObject { /// The **`getTransports()`** method of the [AuthenticatorAttestationResponse] @@ -417,6 +432,11 @@ extension type AuthenticatorAttestationResponse._(JSObject _) /// /// > **Note:** This interface is restricted to top-level contexts. Use from /// > within an `iframe` element will not have any effect. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAssertionResponse). extension type AuthenticatorAssertionResponse._(JSObject _) implements AuthenticatorResponse, JSObject { external JSArrayBuffer get authenticatorData; diff --git a/lib/src/dom/webcryptoapi.dart b/lib/src/dom/webcryptoapi.dart index 59670c0b..ec19e496 100644 --- a/lib/src/dom/webcryptoapi.dart +++ b/lib/src/dom/webcryptoapi.dart @@ -32,6 +32,11 @@ typedef KeyFormat = String; /// [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) /// is accessed through the global [crypto_property] property, which is a /// `Crypto` object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Crypto). extension type Crypto._(JSObject _) implements JSObject { /// The **`Crypto.getRandomValues()`** method lets you get cryptographically /// strong random values. @@ -74,6 +79,11 @@ extension type KeyAlgorithm._(JSObject _) implements JSObject { /// /// For security reasons, the `CryptoKey` interface can only be used in a /// [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey). extension type CryptoKey._(JSObject _) implements JSObject { external KeyType get type; external bool get extractable; @@ -103,6 +113,11 @@ extension type CryptoKey._(JSObject _) implements JSObject { /// > thoroughly reviews it. The [Crypto 101 Course](https://www.crypto101.io/) /// > can be a great place to start learning about the design and implementation /// > of secure systems. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto). extension type SubtleCrypto._(JSObject _) implements JSObject { /// The **`encrypt()`** method of the [SubtleCrypto] interface encrypts data. /// @@ -424,6 +439,11 @@ extension type JsonWebKey._(JSObject _) implements JSObject { /// [`CryptoKey`](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey) /// objects: a `privateKey` property containing the private key and a /// `publicKey` property containing the public key. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKeyPair). extension type CryptoKeyPair._(JSObject _) implements JSObject { external factory CryptoKeyPair({ CryptoKey publicKey, @@ -457,6 +477,11 @@ extension type RsaKeyGenParams._(JSObject _) implements Algorithm, JSObject { /// [RSA-PSS](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#rsa-pss), /// or /// [RSA-OAEP](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#rsa-oaep). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RsaHashedKeyGenParams). extension type RsaHashedKeyGenParams._(JSObject _) implements RsaKeyGenParams, JSObject { external factory RsaHashedKeyGenParams({ @@ -503,6 +528,11 @@ extension type RsaHashedKeyAlgorithm._(JSObject _) /// [RSA-PSS](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#rsa-pss), /// or /// [RSA-OAEP](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#rsa-oaep). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RsaHashedImportParams). extension type RsaHashedImportParams._(JSObject _) implements Algorithm, JSObject { external factory RsaHashedImportParams({ @@ -520,6 +550,11 @@ extension type RsaHashedImportParams._(JSObject _) /// into [SubtleCrypto.sign] or [SubtleCrypto.verify], when using the /// [RSA-PSS](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#rsa-pss) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RsaPssParams). extension type RsaPssParams._(JSObject _) implements Algorithm, JSObject { external factory RsaPssParams({ required String name, @@ -537,6 +572,11 @@ extension type RsaPssParams._(JSObject _) implements Algorithm, JSObject { /// or [SubtleCrypto.unwrapKey], when using the /// [RSA_OAEP](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#rsa-oaep) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RsaOaepParams). extension type RsaOaepParams._(JSObject _) implements Algorithm, JSObject { external factory RsaOaepParams({ required String name, @@ -553,6 +593,11 @@ extension type RsaOaepParams._(JSObject _) implements Algorithm, JSObject { /// into [SubtleCrypto.sign] or [SubtleCrypto.verify] when using the /// [ECDSA](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#ecdsa) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/EcdsaParams). extension type EcdsaParams._(JSObject _) implements Algorithm, JSObject { external factory EcdsaParams({ required String name, @@ -571,6 +616,11 @@ extension type EcdsaParams._(JSObject _) implements Algorithm, JSObject { /// [ECDSA](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#ecdsa) /// or /// [ECDH](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/deriveKey#ecdh). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/EcKeyGenParams). extension type EcKeyGenParams._(JSObject _) implements Algorithm, JSObject { external factory EcKeyGenParams({ required String name, @@ -599,6 +649,11 @@ extension type EcKeyAlgorithm._(JSObject _) implements KeyAlgorithm, JSObject { /// [ECDSA](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#ecdsa) /// or /// [ECDH](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/deriveKey#ecdh). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/EcKeyImportParams). extension type EcKeyImportParams._(JSObject _) implements Algorithm, JSObject { external factory EcKeyImportParams({ required String name, @@ -624,6 +679,11 @@ extension type EcKeyImportParams._(JSObject _) implements Algorithm, JSObject { /// The parameters for ECDH `deriveKey()` therefore include the other entity's /// public key, which is combined with this entity's private key to derive the /// shared secret. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/EcdhKeyDeriveParams). extension type EcdhKeyDeriveParams._(JSObject _) implements Algorithm, JSObject { external factory EcdhKeyDeriveParams({ @@ -674,6 +734,11 @@ extension type EcdhKeyDeriveParams._(JSObject _) /// > **Note:** See /// > [Appendix B of the NIST SP800-38A standard](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf#%5B%7B%22num%22%3A70%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22Fit%22%7D%5D) /// > for more information. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AesCtrParams). extension type AesCtrParams._(JSObject _) implements Algorithm, JSObject { external factory AesCtrParams({ required String name, @@ -706,6 +771,11 @@ extension type AesKeyAlgorithm._(JSObject _) implements KeyAlgorithm, JSObject { /// [AES-GCM](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-gcm), /// or /// [AES-KW](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/wrapKey#aes-kw). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AesKeyGenParams). extension type AesKeyGenParams._(JSObject _) implements Algorithm, JSObject { external factory AesKeyGenParams({ required String name, @@ -733,6 +803,11 @@ extension type AesDerivedKeyParams._(JSObject _) /// or [SubtleCrypto.unwrapKey], when using the /// [AES-CBC](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-cbc) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AesCbcParams). extension type AesCbcParams._(JSObject _) implements Algorithm, JSObject { external factory AesCbcParams({ required String name, @@ -755,6 +830,11 @@ extension type AesCbcParams._(JSObject _) implements Algorithm, JSObject { /// specification for AES-GCM: /// [NIST SP800-38D](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf), /// in particular section 5.2.1.1 on Input Data. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/AesGcmParams). extension type AesGcmParams._(JSObject _) implements Algorithm, JSObject { external factory AesGcmParams({ required String name, @@ -778,6 +858,11 @@ extension type AesGcmParams._(JSObject _) implements Algorithm, JSObject { /// key for the /// [HMAC](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#hmac) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HmacImportParams). extension type HmacImportParams._(JSObject _) implements Algorithm, JSObject { external factory HmacImportParams({ required String name, @@ -810,6 +895,11 @@ extension type HmacKeyAlgorithm._(JSObject _) /// into [SubtleCrypto.generateKey], when generating a key for the /// [HMAC](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/sign#hmac) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HmacKeyGenParams). extension type HmacKeyGenParams._(JSObject _) implements Algorithm, JSObject { external factory HmacKeyGenParams({ required String name, @@ -829,6 +919,11 @@ extension type HmacKeyGenParams._(JSObject _) implements Algorithm, JSObject { /// into [SubtleCrypto.deriveKey], when using the /// [HKDF](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/deriveKey#hkdf) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HkdfParams). extension type HkdfParams._(JSObject _) implements Algorithm, JSObject { external factory HkdfParams({ required String name, @@ -851,6 +946,11 @@ extension type HkdfParams._(JSObject _) implements Algorithm, JSObject { /// into [SubtleCrypto.deriveKey], when using the /// [PBKDF2](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/deriveKey#pbkdf2) /// algorithm. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Pbkdf2Params). extension type Pbkdf2Params._(JSObject _) implements Algorithm, JSObject { external factory Pbkdf2Params({ required String name, diff --git a/lib/src/dom/webgl1.dart b/lib/src/dom/webgl1.dart index 2778fc59..b8f34ba6 100644 --- a/lib/src/dom/webgl1.dart +++ b/lib/src/dom/webgl1.dart @@ -76,16 +76,31 @@ extension type WebGLContextAttributes._(JSObject _) implements JSObject { /// /// If the WebGL context is lost, the internal _invalidated_ flag of all /// `WebGLObject` instances is set to `true`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLObject). extension type WebGLObject._(JSObject _) implements JSObject {} /// The **WebGLBuffer** interface is part of the /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// represents an opaque buffer object storing data such as vertices or colors. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLBuffer). extension type WebGLBuffer._(JSObject _) implements WebGLObject, JSObject {} /// The **WebGLFramebuffer** interface is part of the /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// represents a collection of buffers that serve as a rendering destination. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLFramebuffer). extension type WebGLFramebuffer._(JSObject _) implements WebGLObject, JSObject {} @@ -116,12 +131,22 @@ extension type WebGLFramebuffer._(JSObject _) /// /// See [WebGLShader] for information on creating the `vertexShader` and /// `fragmentShader` in the above example. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLProgram). extension type WebGLProgram._(JSObject _) implements WebGLObject, JSObject {} /// The **WebGLRenderbuffer** interface is part of the /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// represents a buffer that can contain an image, or that can be a source or /// target of a rendering operation. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderbuffer). extension type WebGLRenderbuffer._(JSObject _) implements WebGLObject, JSObject {} @@ -129,17 +154,32 @@ extension type WebGLRenderbuffer._(JSObject _) /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// can either be a vertex or a fragment shader. A [WebGLProgram] requires both /// types of shaders. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLShader). extension type WebGLShader._(JSObject _) implements WebGLObject, JSObject {} /// The **WebGLTexture** interface is part of the /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// represents an opaque texture object providing storage and state for /// texturing operations. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTexture). extension type WebGLTexture._(JSObject _) implements WebGLObject, JSObject {} /// The **WebGLUniformLocation** interface is part of the /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// represents the location of a uniform variable in a shader program. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLUniformLocation). extension type WebGLUniformLocation._(JSObject _) implements JSObject {} /// The **WebGLActiveInfo** interface is part of the @@ -147,6 +187,11 @@ extension type WebGLUniformLocation._(JSObject _) implements JSObject {} /// represents the information returned by calling the /// [WebGLRenderingContext.getActiveAttrib] and /// [WebGLRenderingContext.getActiveUniform] methods. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLActiveInfo). extension type WebGLActiveInfo._(JSObject _) implements JSObject { external GLint get size; external GLenum get type; @@ -157,6 +202,11 @@ extension type WebGLActiveInfo._(JSObject _) implements JSObject { /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// represents the information returned by calling the /// [WebGLRenderingContext.getShaderPrecisionFormat] method. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLShaderPrecisionFormat). extension type WebGLShaderPrecisionFormat._(JSObject _) implements JSObject { external GLint get rangeMin; external GLint get rangeMax; @@ -184,6 +234,11 @@ extension type WebGLShaderPrecisionFormat._(JSObject _) implements JSObject { /// /// If you require a WebGL 2.0 context, see [WebGL2RenderingContext]; this /// supplies access to an implementation of OpenGL ES 3.0 graphics. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext). extension type WebGLRenderingContext._(JSObject _) implements JSObject { external static GLenum get DEPTH_BUFFER_BIT; external static GLenum get STENCIL_BUFFER_BIT; @@ -1717,6 +1772,11 @@ extension type WebGLRenderingContext._(JSObject _) implements JSObject { /// [WebGL API](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and /// is an interface for an event that is generated in response to a status /// change to the WebGL rendering context. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLContextEvent). extension type WebGLContextEvent._(JSObject _) implements Event, JSObject { external factory WebGLContextEvent( String type, [ diff --git a/lib/src/dom/webgl2.dart b/lib/src/dom/webgl2.dart index 98ce5360..1c3fbb10 100644 --- a/lib/src/dom/webgl2.dart +++ b/lib/src/dom/webgl2.dart @@ -40,6 +40,11 @@ typedef Uint32List = JSObject; /// - [WebGL2RenderingContext.endQuery] /// - [WebGL2RenderingContext.getQuery] /// - [WebGL2RenderingContext.getQueryParameter] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLQuery). extension type WebGLQuery._(JSObject _) implements WebGLObject, JSObject {} /// The **`WebGLSampler`** interface is part of the @@ -54,6 +59,11 @@ extension type WebGLQuery._(JSObject _) implements WebGLObject, JSObject {} /// - [WebGL2RenderingContext.isSampler] /// - [WebGL2RenderingContext.bindSampler] /// - [WebGL2RenderingContext.getSamplerParameter] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLSampler). extension type WebGLSampler._(JSObject _) implements WebGLObject, JSObject {} /// The **`WebGLSync`** interface is part of the @@ -69,6 +79,11 @@ extension type WebGLSampler._(JSObject _) implements WebGLObject, JSObject {} /// - [WebGL2RenderingContext.clientWaitSync] /// - [WebGL2RenderingContext.waitSync] /// - [WebGL2RenderingContext.getSyncParameter] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLSync). extension type WebGLSync._(JSObject _) implements WebGLObject, JSObject {} /// The **`WebGLTransformFeedback`** interface is part of the @@ -90,6 +105,11 @@ extension type WebGLSync._(JSObject _) implements WebGLObject, JSObject {} /// - [WebGL2RenderingContext.resumeTransformFeedback] /// - [WebGL2RenderingContext.transformFeedbackVaryings] /// - [WebGL2RenderingContext.getTransformFeedbackVarying] +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTransformFeedback). extension type WebGLTransformFeedback._(JSObject _) implements WebGLObject, JSObject {} @@ -108,6 +128,11 @@ extension type WebGLTransformFeedback._(JSObject _) /// /// > **Note:** The [OES_vertex_array_object] extension allows you to use vertex /// > array objects in a WebGL 1 context. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGLVertexArrayObject). extension type WebGLVertexArrayObject._(JSObject _) implements WebGLObject, JSObject {} @@ -132,6 +157,11 @@ extension type WebGLVertexArrayObject._(JSObject _) /// [WebGL tutorial](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Tutorial) /// has more information, examples, and resources on how to get started with /// WebGL. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext). extension type WebGL2RenderingContext._(JSObject _) implements JSObject { external static GLenum get DEPTH_BUFFER_BIT; external static GLenum get STENCIL_BUFFER_BIT; diff --git a/lib/src/dom/webidl.dart b/lib/src/dom/webidl.dart index 7c766002..f5497f09 100644 --- a/lib/src/dom/webidl.dart +++ b/lib/src/dom/webidl.dart @@ -29,6 +29,11 @@ typedef VoidFunction = JSFunction; /// `DOMException` is a , so it can be cloned with [structuredClone] or copied /// between [Workers](https://developer.mozilla.org/en-US/docs/Web/API/Worker) /// using [Worker.postMessage]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMException). extension type DOMException._(JSObject _) implements JSObject { external factory DOMException([ String message, diff --git a/lib/src/dom/webrtc.dart b/lib/src/dom/webrtc.dart index 09b0d963..79d0aa7b 100644 --- a/lib/src/dom/webrtc.dart +++ b/lib/src/dom/webrtc.dart @@ -110,6 +110,11 @@ extension type RTCAnswerOptions._(JSObject _) /// the local computer and a remote peer. /// It provides methods to connect to a remote peer, maintain and monitor the /// connection, and close the connection once it's no longer needed. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection). extension type RTCPeerConnection._(JSObject _) implements EventTarget, JSObject { external factory RTCPeerConnection([RTCConfiguration configuration]); @@ -453,6 +458,11 @@ extension type RTCPeerConnection._(JSObject _) /// description suggesting one combination of connection configuration options /// that the sender of the description supports. Once the two peers agree upon a /// configuration for the connection, negotiation is complete. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCSessionDescription). extension type RTCSessionDescription._(JSObject _) implements JSObject { external factory RTCSessionDescription( RTCSessionDescriptionInit descriptionInitDict); @@ -506,6 +516,11 @@ extension type RTCLocalSessionDescriptionInit._(JSObject _) /// The article /// [WebRTC connectivity](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Connectivity) /// provides additional useful details. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate). extension type RTCIceCandidate._(JSObject _) implements JSObject { external factory RTCIceCandidate([RTCIceCandidateInit candidateInitDict]); @@ -554,6 +569,11 @@ extension type RTCIceCandidateInit._(JSObject _) implements JSObject { /// in relation to candidates with the target, usually an [RTCPeerConnection]. /// /// Only one event is of this type: [RTCPeerConnection.icecandidate_event]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnectionIceEvent). extension type RTCPeerConnectionIceEvent._(JSObject _) implements Event, JSObject { external factory RTCPeerConnectionIceEvent( @@ -584,6 +604,11 @@ extension type RTCPeerConnectionIceEventInit._(JSObject _) /// interface—provides details pertaining to an error announced by sending an /// [RTCPeerConnection.icecandidateerror_event] event to the [RTCPeerConnection] /// object. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnectionIceErrorEvent). extension type RTCPeerConnectionIceErrorEvent._(JSObject _) implements Event, JSObject { external factory RTCPeerConnectionIceErrorEvent( @@ -636,6 +661,11 @@ extension type RTCCertificateExpiration._(JSObject _) implements JSObject { /// `RTCCertificate` is a , so it can be cloned with [structuredClone] or copied /// between [Workers](https://developer.mozilla.org/en-US/docs/Web/API/Worker) /// using [Worker/postMessage]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCCertificate). extension type RTCCertificate._(JSObject _) implements JSObject { /// The **`getFingerprints()`** method of the **[RTCCertificate]** interface /// is used to get an array of certificate fingerprints. @@ -672,6 +702,11 @@ extension type RTCRtpTransceiverInit._(JSObject _) implements JSObject { /// also obtain access to an [RTCDTMFSender] which can be used to send codes /// (to simulate the user pressing buttons on a telephone's dial pad) to the /// remote peer. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpSender). extension type RTCRtpSender._(JSObject _) implements JSObject { external static RTCRtpCapabilities? getCapabilities(String kind); external JSPromise generateKeyFrame([JSArray rids]); @@ -847,6 +882,11 @@ extension type RTCRtpCodec._(JSObject _) implements JSObject { /// maintained by the Internet Assigned Numbers Authority (IANA). References to /// relevant IANA documents are provided in the [see also](#see_also) section at /// the end of this article. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpCodecParameters). extension type RTCRtpCodecParameters._(JSObject _) implements RTCRtpCodec, JSObject { external factory RTCRtpCodecParameters({ @@ -895,6 +935,11 @@ extension type RTCSetParameterOptions._(JSObject _) implements JSObject { /// [WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) /// manages the reception and decoding of data for a [MediaStreamTrack] on an /// [RTCPeerConnection]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpReceiver). extension type RTCRtpReceiver._(JSObject _) implements JSObject { external static RTCRtpCapabilities? getCapabilities(String kind); @@ -968,6 +1013,11 @@ extension type RTCRtpSynchronizationSource._(JSObject _) /// property, which is the same as the media ID (`mid`) of its corresponding /// m-line. An `RTCRtpTransceiver` is **associated** with an m-line if its `mid` /// is non-null; otherwise it's considered disassociated. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpTransceiver). extension type RTCRtpTransceiver._(JSObject _) implements JSObject { /// The **`stop()`** method in the [RTCRtpTransceiver] interface permanently /// stops the transceiver by stopping both the associated [RTCRtpSender] and @@ -1010,6 +1060,11 @@ extension type RTCRtpTransceiver._(JSObject _) implements JSObject { /// underlying transport; the `RTCDtlsTransport` interface can be used to obtain /// information about the underlying transport and the security added to it by /// the DTLS layer. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCDtlsTransport). extension type RTCDtlsTransport._(JSObject _) implements EventTarget, JSObject { external JSArray getRemoteCertificates(); external RTCIceTransport get iceTransport; @@ -1035,6 +1090,11 @@ extension type RTCDtlsFingerprint._(JSObject _) implements JSObject { /// transport layer over which the data is being sent and received. /// This is particularly useful if you need to access state information about /// the connection. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceTransport). extension type RTCIceTransport._(JSObject _) implements EventTarget, JSObject { /// The **[RTCIceTransport]** method /// **`getLocalCandidates()`** returns an array of @@ -1108,6 +1168,11 @@ extension type RTCIceTransport._(JSObject _) implements EventTarget, JSObject { /// [RTCIceTransport] by calling its [RTCIceTransport.getLocalParameters] or /// [RTCIceTransport.getRemoteParameters] method, depending on which end /// interests you. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceParameters). extension type RTCIceParameters._(JSObject _) implements JSObject { external factory RTCIceParameters({ String usernameFragment, @@ -1125,6 +1190,11 @@ extension type RTCIceParameters._(JSObject _) implements JSObject { /// WebRTC endpoints. It is used as the return value from /// [RTCIceTransport.getSelectedCandidatePair] to identify the /// currently-selected candidate pair identified by the ICE agent. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidatePair). extension type RTCIceCandidatePair._(JSObject _) implements JSObject { external factory RTCIceCandidatePair({ RTCIceCandidate local, @@ -1148,6 +1218,11 @@ extension type RTCIceCandidatePair._(JSObject _) implements JSObject { /// /// This event is sent by the WebRTC layer to the website or application, so you /// will not typically need to instantiate an `RTCTrackEvent` yourself. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCTrackEvent). extension type RTCTrackEvent._(JSObject _) implements Event, JSObject { external factory RTCTrackEvent( String type, @@ -1195,6 +1270,11 @@ extension type RTCTrackEventInit._(JSObject _) implements EventInit, JSObject { /// [`maxMessageSize`](#rtcsctptransport.maxmessagesize) property, which you can /// use to determine the upper limit on the size of messages you can send over a /// data channel on the peer connection. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCSctpTransport). extension type RTCSctpTransport._(JSObject _) implements EventTarget, JSObject { external RTCDtlsTransport get transport; external RTCSctpTransportState get state; @@ -1219,6 +1299,11 @@ extension type RTCSctpTransport._(JSObject _) implements EventTarget, JSObject { /// /// `RTCDataChannel` is a /// [transferable object](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel). extension type RTCDataChannel._(JSObject _) implements EventTarget, JSObject { /// The **`RTCDataChannel.close()`** method closes the /// [RTCDataChannel]. Either peer is permitted to call this method to initiate @@ -1324,6 +1409,11 @@ extension type RTCDataChannelInit._(JSObject _) implements JSObject { /// The **`RTCDataChannelEvent`** interface /// represents an event related to a specific [RTCDataChannel]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannelEvent). extension type RTCDataChannelEvent._(JSObject _) implements Event, JSObject { external factory RTCDataChannelEvent( String type, @@ -1360,6 +1450,11 @@ extension type RTCDataChannelEventInit._(JSObject _) /// services. For that reason, DTMF can't be used between two WebRTC-based /// devices, because there is no mechanism provided by WebRTC for receiving DTMF /// codes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCDTMFSender). extension type RTCDTMFSender._(JSObject _) implements EventTarget, JSObject { /// The **`insertDTMF()`** method on the [RTCDTMFSender] interface /// starts sending tones to the remote peer over the @@ -1396,6 +1491,11 @@ extension type RTCDTMFSender._(JSObject _) implements EventTarget, JSObject { /// used by the /// [`tonechange`](https://developer.mozilla.org/en-US/docs/Web/API/RTCDTMFSender/tonechange_event) /// event. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCDTMFToneChangeEvent). extension type RTCDTMFToneChangeEvent._(JSObject _) implements Event, JSObject { external factory RTCDTMFToneChangeEvent( String type, [ @@ -1427,6 +1527,11 @@ extension type RTCDTMFToneChangeEventInit._(JSObject _) /// in which each key is an identifier for an object for which statistics are /// being reported, and the corresponding value is a dictionary object providing /// the statistics. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport). extension type RTCStatsReport._(JSObject _) implements JSObject {} extension type RTCStats._(JSObject _) implements JSObject { external factory RTCStats({ @@ -1448,6 +1553,11 @@ extension type RTCStats._(JSObject _) implements JSObject { /// [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) /// operations. It's based upon the standard [DOMException] interface that /// describes general DOM errors. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCError). extension type RTCError._(JSObject _) implements DOMException, JSObject { external factory RTCError( RTCErrorInit init, [ @@ -1484,6 +1594,11 @@ extension type RTCErrorInit._(JSObject _) implements JSObject { /// The WebRTC API's **`RTCErrorEvent`** interface represents an error sent to a /// WebRTC object. It's based on the standard [Event] interface, but adds /// RTC-specific information describing the error, as shown below. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCErrorEvent). extension type RTCErrorEvent._(JSObject _) implements Event, JSObject { external factory RTCErrorEvent( String type, diff --git a/lib/src/dom/webrtc_encoded_transform.dart b/lib/src/dom/webrtc_encoded_transform.dart index 4bc7c40c..7db6d4fc 100644 --- a/lib/src/dom/webrtc_encoded_transform.dart +++ b/lib/src/dom/webrtc_encoded_transform.dart @@ -121,6 +121,11 @@ extension type RTCEncodedVideoFrameMetadata._(JSObject _) implements JSObject { /// /// > **Note:** This feature is available in /// > [_Dedicated_ Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_types). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCEncodedVideoFrame). extension type RTCEncodedVideoFrame._(JSObject _) implements JSObject { /// The **`getMetadata()`** method of the [RTCEncodedVideoFrame] interface /// returns an object containing the metadata associated with the frame. @@ -171,6 +176,11 @@ extension type RTCEncodedAudioFrameMetadata._(JSObject _) implements JSObject { /// /// > **Note:** This feature is available in /// > [_Dedicated_ Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_types). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCEncodedAudioFrame). extension type RTCEncodedAudioFrame._(JSObject _) implements JSObject { /// The **`getMetadata()`** method of the [RTCEncodedAudioFrame] interface /// returns an object containing the metadata associated with the frame. @@ -197,6 +207,11 @@ extension type RTCEncodedAudioFrame._(JSObject _) implements JSObject { /// /// At time of writing there is just one event based on `RTCTransformEvent`: /// [DedicatedWorkerGlobalScope.rtctransform_event]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCTransformEvent). extension type RTCTransformEvent._(JSObject _) implements Event, JSObject { external RTCRtpScriptTransformer get transformer; } @@ -212,6 +227,11 @@ extension type RTCTransformEvent._(JSObject _) implements Event, JSObject { /// /// > **Note:** This feature is available in /// > [_Dedicated_ Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_types). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpScriptTransformer). extension type RTCRtpScriptTransformer._(JSObject _) implements EventTarget, JSObject { /// The **`generateKeyFrame()`** method of the [RTCRtpScriptTransformer] @@ -251,6 +271,11 @@ extension type RTCRtpScriptTransformer._(JSObject _) /// [WebRTC Encoded Transform](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Using_Encoded_Transforms) /// (a [TransformStream] running in a worker thread) into the WebRTC sender and /// receiver pipelines. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpScriptTransform). extension type RTCRtpScriptTransform._(JSObject _) implements JSObject { external factory RTCRtpScriptTransform( Worker worker, [ diff --git a/lib/src/dom/webrtc_stats.dart b/lib/src/dom/webrtc_stats.dart index da38e975..1bdeb878 100644 --- a/lib/src/dom/webrtc_stats.dart +++ b/lib/src/dom/webrtc_stats.dart @@ -37,6 +37,11 @@ typedef RTCStatsIceCandidatePairState = String; /// > specification update in the spring of 2017. /// > Check the [Browser compatibility](#browser_compatibility) table to know if /// > and when the name change was implemented in specific browsers. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpStreamStats). extension type RTCRtpStreamStats._(JSObject _) implements RTCStats, JSObject { external factory RTCRtpStreamStats({ required DOMHighResTimeStamp timestamp, @@ -114,6 +119,11 @@ extension type RTCReceivedRtpStreamStats._(JSObject _) /// The statistics can be obtained by iterating the [RTCStatsReport] returned by /// [RTCPeerConnection.getStats] or [RTCRtpReceiver.getStats] until you find a /// report with the [`type`](#type) of `inbound-rtp`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCInboundRtpStreamStats). extension type RTCInboundRtpStreamStats._(JSObject _) implements RTCReceivedRtpStreamStats, JSObject { external factory RTCInboundRtpStreamStats({ @@ -348,6 +358,11 @@ extension type RTCSentRtpStreamStats._(JSObject _) /// The statistics can be obtained by iterating the [RTCStatsReport] returned by /// [RTCPeerConnection.getStats] or [RTCRtpSender.getStats] until you find a /// report with the [`type`](#type) of `outbound-rtp`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCOutboundRtpStreamStats). extension type RTCOutboundRtpStreamStats._(JSObject _) implements RTCSentRtpStreamStats, JSObject { external factory RTCOutboundRtpStreamStats({ @@ -463,6 +478,11 @@ extension type RTCOutboundRtpStreamStats._(JSObject _) /// The statistics can be obtained by iterating the [RTCStatsReport] returned by /// [RTCPeerConnection.getStats] until you find a report with the /// [`type`](#type) of `remote-outbound-rtp`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats). extension type RTCRemoteOutboundRtpStreamStats._(JSObject _) implements RTCSentRtpStreamStats, JSObject { external factory RTCRemoteOutboundRtpStreamStats({ @@ -523,6 +543,11 @@ extension type RTCMediaSourceStats._(JSObject _) implements RTCStats, JSObject { /// /// > **Note:** For audio information about remotely sourced tracks (that are /// > being received), see [RTCInboundRtpStreamStats]. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCAudioSourceStats). extension type RTCAudioSourceStats._(JSObject _) implements RTCMediaSourceStats, JSObject { external factory RTCAudioSourceStats({ @@ -612,6 +637,11 @@ extension type RTCAudioPlayoutStats._(JSObject _) /// These statistics can be obtained by iterating the [RTCStatsReport] returned /// by [RTCPeerConnection.getStats] until you find a report with the /// [`type`](#type) of `peer-connection`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnectionStats). extension type RTCPeerConnectionStats._(JSObject _) implements RTCStats, JSObject { external factory RTCPeerConnectionStats({ @@ -680,6 +710,11 @@ extension type RTCDataChannelStats._(JSObject _) implements RTCStats, JSObject { /// These statistics can be obtained by iterating the [RTCStatsReport] returned /// by [RTCPeerConnection.getStats] until you find a report with the /// [`type`](#type) of `transport`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCTransportStats). extension type RTCTransportStats._(JSObject _) implements RTCStats, JSObject { external factory RTCTransportStats({ required DOMHighResTimeStamp timestamp, @@ -744,6 +779,11 @@ extension type RTCTransportStats._(JSObject _) implements RTCStats, JSObject { /// The statistics can be obtained by iterating the [RTCStatsReport] returned by /// [RTCPeerConnection.getStats] until you find a report with the /// [`type`](#type) of `local-candidate`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidateStats). extension type RTCIceCandidateStats._(JSObject _) implements RTCStats, JSObject { external factory RTCIceCandidateStats({ @@ -802,6 +842,11 @@ extension type RTCIceCandidateStats._(JSObject _) /// The statistics can be obtained by iterating the [RTCStatsReport] returned by /// [RTCPeerConnection.getStats] until you find an entry with the /// [`type`](#type) of `"candidate-pair"`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidatePairStats). extension type RTCIceCandidatePairStats._(JSObject _) implements RTCStats, JSObject { external factory RTCIceCandidatePairStats({ @@ -886,6 +931,11 @@ extension type RTCIceCandidatePairStats._(JSObject _) /// The report can be obtained by iterating the [RTCStatsReport] returned by /// [RTCPeerConnection.getStats] until you find an entry with the /// [`type`](#type) of `certificate`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCCertificateStats). extension type RTCCertificateStats._(JSObject _) implements RTCStats, JSObject { external factory RTCCertificateStats({ required DOMHighResTimeStamp timestamp, diff --git a/lib/src/dom/websockets.dart b/lib/src/dom/websockets.dart index 8f8115ea..3ab529a3 100644 --- a/lib/src/dom/websockets.dart +++ b/lib/src/dom/websockets.dart @@ -25,6 +25,11 @@ typedef BinaryType = String; /// /// To construct a `WebSocket`, use the /// [`WebSocket()`](/en-US/docs/Web/API/WebSocket/WebSocket) constructor. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket). extension type WebSocket._(JSObject _) implements EventTarget, JSObject { external factory WebSocket( String url, [ @@ -83,6 +88,11 @@ extension type WebSocket._(JSObject _) implements EventTarget, JSObject { /// A `CloseEvent` is sent to clients using when the connection is closed. This /// is delivered to the listener indicated by the `WebSocket` object's `onclose` /// attribute. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent). extension type CloseEvent._(JSObject _) implements Event, JSObject { external factory CloseEvent( String type, [ diff --git a/lib/src/dom/webvtt.dart b/lib/src/dom/webvtt.dart index 1abdac40..0a1e569a 100644 --- a/lib/src/dom/webvtt.dart +++ b/lib/src/dom/webvtt.dart @@ -27,6 +27,11 @@ typedef ScrollSetting = String; /// The `VTTCue` interface—part of the API for handling WebVTT (text tracks on /// media presentations)—describes and controls the text track associated with a /// particular `track` element. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/VTTCue). extension type VTTCue._(JSObject _) implements TextTrackCue, JSObject { external factory VTTCue( num startTime, @@ -62,6 +67,11 @@ extension type VTTCue._(JSObject _) implements TextTrackCue, JSObject { /// The `VTTRegion` interface—part of the API for handling WebVTT (text tracks /// on media presentations)—describes a portion of the video to render a /// [VTTCue] onto. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/VTTRegion). extension type VTTRegion._(JSObject _) implements JSObject { external factory VTTRegion(); diff --git a/lib/src/dom/xhr.dart b/lib/src/dom/xhr.dart index 5c9872aa..dc3e4b29 100644 --- a/lib/src/dom/xhr.dart +++ b/lib/src/dom/xhr.dart @@ -24,6 +24,11 @@ typedef XMLHttpRequestResponseType = String; /// /// You don't use `XMLHttpRequestEventTarget` directly; instead you interact /// with the sub classes. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequestEventTarget). extension type XMLHttpRequestEventTarget._(JSObject _) implements EventTarget, JSObject { external set onloadstart(EventHandler value); @@ -49,6 +54,11 @@ extension type XMLHttpRequestEventTarget._(JSObject _) /// [XMLHttpRequest.upload]. /// /// @AvailableInWorkers("notservice") +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequestUpload). extension type XMLHttpRequestUpload._(JSObject _) implements XMLHttpRequestEventTarget, JSObject {} @@ -68,6 +78,11 @@ extension type XMLHttpRequestUpload._(JSObject _) /// may be a better choice. /// /// @AvailableInWorkers("notservice") +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest). extension type XMLHttpRequest._(JSObject _) implements XMLHttpRequestEventTarget, JSObject { external factory XMLHttpRequest(); @@ -227,6 +242,11 @@ extension type XMLHttpRequest._(JSObject _) /// An object implementing `FormData` can directly be used in a `for...of` /// structure, instead of [FormData.entries]: `for (const p of myFormData)` is /// equivalent to `for (const p of myFormData.entries())`. +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/FormData). extension type FormData._(JSObject _) implements JSObject { external factory FormData([ HTMLFormElement form, @@ -285,6 +305,11 @@ extension type FormData._(JSObject _) implements JSObject { /// underlying process, like an HTTP request (for an `XMLHttpRequest`, or the /// loading of the underlying resource of an `img`, `audio`, `video`, `style` or /// `link`). +/// +/// --- +/// +/// API documentation sourced from +/// [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent). extension type ProgressEvent._(JSObject _) implements Event, JSObject { external factory ProgressEvent( String type, [ diff --git a/test/generate_docs_test.dart b/test/generate_docs_test.dart index 94839be4..00674a3a 100644 --- a/test/generate_docs_test.dart +++ b/test/generate_docs_test.dart @@ -59,6 +59,27 @@ Lorem ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum lorem ip '''); }); + test('tables don\'t wrap', () { + compare(''' +Some text. + +| Attribute | Namespace name | Namespace prefix | Attribute local name | Attribute qualified name | +| --------- | -------------- | ---------------- | -------------------- | ------------------------ | +| `myAttr` | _none_ | _none_ | `myAttr` | `myAttr` | +| `myAttr` | `mynamespace` | _none_ | `myAttr` | `myAttr` | +| `myAttr` | `mynamespace` | `myns` | `myAttr` | `myns:myAttr` | + +''', ''' +/// Some text. +/// +/// | Attribute | Namespace name | Namespace prefix | Attribute local name | Attribute qualified name | +/// | --------- | -------------- | ---------------- | -------------------- | ------------------------ | +/// | `myAttr` | _none_ | _none_ | `myAttr` | `myAttr` | +/// | `myAttr` | `mynamespace` | _none_ | `myAttr` | `myAttr` | +/// | `myAttr` | `mynamespace` | `myns` | `myAttr` | `myns:myAttr` | +'''); + }); + test('references', () { compare(''' [foo] diff --git a/third_party/mdn/mdn.json b/third_party/mdn/mdn.json index bb14aab6..f2711610 100644 --- a/third_party/mdn/mdn.json +++ b/third_party/mdn/mdn.json @@ -3,14 +3,22 @@ "source": "[MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web)", "license": "[CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/)" }, - "abortcontroller": { + "ANGLE_instanced_arrays": { + "docs": "The **`ANGLE_instanced_arrays`** extension is part of the [WebGL API](/en-US/docs/Web/API/WebGL_API) and allows to draw the same object, or groups of similar objects multiple times, if they share the same vertex data, primitive count and type.\n\nWebGL extensions are available using the [WebGLRenderingContext.getExtension] method. For more information, see also [Using Extensions](/en-US/docs/Web/API/WebGL_API/Using_Extensions) in the [WebGL tutorial](/en-US/docs/Web/API/WebGL_API/Tutorial).\n\n> **Note:** This extension is only available to [WebGLRenderingContext] contexts. In [WebGL2RenderingContext], the functionality of this extension is available on the WebGL2 context by default and the constants and methods are available without the \"`ANGLE`\" suffix.\n>\n> Despite the name \"ANGLE\", this extension works on any device if the hardware supports it and not just on Windows when using the ANGLE library. \"ANGLE\" just indicates that this extension has been written by the ANGLE library authors.", + "properties": { + "drawarraysinstancedangle": "The **`ANGLE_instanced_arrays.drawArraysInstancedANGLE()`** method of the [WebGL API](/en-US/docs/Web/API/WebGL_API) renders primitives from array data like the [WebGLRenderingContext.drawArrays] method. In addition, it can execute multiple instances of the range of elements.\n\n> **Note:** When using [WebGL2RenderingContext], this method is available as [WebGL2RenderingContext.drawArraysInstanced] by default.", + "drawelementsinstancedangle": "The **`ANGLE_instanced_arrays.drawElementsInstancedANGLE()`** method of the [WebGL API](/en-US/docs/Web/API/WebGL_API) renders primitives from array data like the [WebGLRenderingContext.drawElements] method. In addition, it can execute multiple instances of a set of elements.\n\n> **Note:** When using [WebGL2RenderingContext], this method is available as [WebGL2RenderingContext.drawElementsInstanced] by default.", + "vertexattribdivisorangle": "The **ANGLE_instanced_arrays.vertexAttribDivisorANGLE()** method of the [WebGL API](/en-US/docs/Web/API/WebGL_API) modifies the rate at which generic vertex attributes advance when rendering multiple instances of primitives with [ANGLE_instanced_arrays.drawArraysInstancedANGLE] and [ANGLE_instanced_arrays.drawElementsInstancedANGLE].\n\n> **Note:** When using [WebGL2RenderingContext], this method is available as [WebGL2RenderingContext.vertexAttribDivisor] by default." + } + }, + "AbortController": { "docs": "The **`AbortController`** interface represents a controller object that allows you to abort one or more Web requests as and when desired.\n\nYou can create a new `AbortController` object using the [AbortController.AbortController] constructor. Communicating with an asynchronous operation is done using an [AbortSignal] object.", "properties": { "abort": "The **`abort()`** method of the [AbortController] interface aborts an asynchronous operation before it has completed.\nThis is able to abort [fetch requests](/en-US/docs/Web/API/fetch), the consumption of any response bodies, or streams.", "signal": "The **`signal`** read-only property of the [AbortController] interface returns an [AbortSignal] object instance, which can be used to communicate with/abort an asynchronous operation as desired." } }, - "abortsignal": { + "AbortSignal": { "docs": "The **`AbortSignal`** interface represents a signal object that allows you to communicate with an asynchronous operation (such as a fetch request) and abort it if required via an [AbortController] object.", "properties": { "abort_event": "The **`abort`** event of the [AbortSignal] is fired when the associated request is aborted, i.e. using [AbortController.abort].", @@ -22,10 +30,10 @@ "timeout_static": "The **`AbortSignal.timeout()`** static method returns an [AbortSignal] that will automatically abort after a specified time.\n\nThe signal aborts with a `TimeoutError` [DOMException] on timeout, or with `AbortError` [DOMException] due to pressing a browser stop button (or some other inbuilt \"stop\" operation).\nThis allows UIs to differentiate timeout errors, which typically require user notification, from user-triggered aborts that do not.\n\nThe timeout is based on active rather than elapsed time, and will effectively be paused if the code is running in a suspended worker, or while the document is in a back-forward cache (\"[bfcache](https://web.dev/articles/bfcache)\").\n\nTo combine multiple signals, you can use [AbortSignal/any_static], for example, to directly abort a download using either a timeout signal or by calling [AbortController.abort]." } }, - "absoluteorientationsensor": { + "AbsoluteOrientationSensor": { "docs": "The **`AbsoluteOrientationSensor`** interface of the [Sensor APIs](/en-US/docs/Web/API/Sensor_APIs) describes the device's physical orientation in relation to the Earth's reference coordinate system.\n\nTo use this sensor, the user must grant permission to the `'accelerometer'`, `'gyroscope'`, and `'magnetometer'` device sensors through the [Permissions API](/en-US/docs/Web/API/Permissions_API).\n\nThis feature may be blocked by a [Permissions Policy](/en-US/docs/Web/HTTP/Permissions_Policy) set on your server." }, - "abstractrange": { + "AbstractRange": { "docs": "The **`AbstractRange`** abstract interface is the base class upon which all range types are defined. A **range** is an object that indicates the start and end points of a section of content within the document.\n\n> **Note:** As an abstract interface, you will not directly instantiate an object of type `AbstractRange`. Instead, you will use the [Range] or [StaticRange] interfaces. To understand the difference between those two interfaces, and how to choose which is appropriate for your needs, consult each interface's documentation.", "properties": { "collapsed": "The read-only **`collapsed`** property of the [AbstractRange] interface returns `true` if the range's start position and end position are the same.", @@ -35,7 +43,7 @@ "startoffset": "The read-only **`startOffset`** property of the [AbstractRange] interface returns the offset into the start node of the range's start position." } }, - "accelerometer": { + "Accelerometer": { "docs": "The **`Accelerometer`** interface of the [Sensor APIs](/en-US/docs/Web/API/Sensor_APIs) provides on each reading the acceleration applied to the device along all three axes.\n\nTo use this sensor, the user must grant permission to the `'accelerometer'`, device sensor through the [Permissions API](/en-US/docs/Web/API/Permissions_API).\n\nThis feature may be blocked by a [Permissions Policy](/en-US/docs/Web/HTTP/Permissions_Policy) set on your server.", "properties": { "x": "The **`x`** read-only property of the [Accelerometer] interface returns a number specifying the acceleration of the device along its x-axis.", @@ -43,25 +51,25 @@ "z": "The **`z`** read-only property of the [Accelerometer] interface returns a number specifying the acceleration of the device along its z-axis." } }, - "aescbcparams": { + "AesCbcParams": { "docs": "The **`AesCbcParams`** dictionary of the [Web Crypto API](/en-US/docs/Web/API/Web_Crypto_API) represents the object that should be passed as the `algorithm` parameter into [SubtleCrypto.encrypt], [SubtleCrypto.decrypt], [SubtleCrypto.wrapKey], or [SubtleCrypto.unwrapKey], when using the [AES-CBC](/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-cbc) algorithm." }, - "aesctrparams": { + "AesCtrParams": { "docs": "The **`AesCtrParams`** dictionary of the [Web Crypto API](/en-US/docs/Web/API/Web_Crypto_API) represents the object that should be passed as the `algorithm` parameter into [SubtleCrypto.encrypt], [SubtleCrypto.decrypt], [SubtleCrypto.wrapKey], or [SubtleCrypto.unwrapKey], when using the [AES-CTR](/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-ctr) algorithm.\n\nAES is a block cipher, meaning that it splits the message into blocks and encrypts it a block at a time. In CTR mode, every time a block of the message is encrypted, an extra block of data is mixed in. This extra block is called the \"counter block\".\n\nA given counter block value must never be used more than once with the same key:\n\n- Given a message _n_ blocks long, a different counter block must be used for every block.\n- If the same key is used to encrypt more than one message, a different counter block must be used for all blocks across all messages.\n\nTypically this is achieved by splitting the initial counter block value into two concatenated parts:\n\n- A [nonce](https://en.wikipedia.org/wiki/Cryptographic_nonce) (that is, a number that may only be used once). The nonce part of the block stays the same for every block in the message. Each time a new message is to be encrypted, a new nonce is chosen. Nonces don't have to be secret, but they must not be reused with the same key.\n- A counter. This part of the block gets incremented each time a block is encrypted.\n\nEssentially: the nonce should ensure that counter blocks are not reused from one message to the next, while the counter should ensure that counter blocks are not reused within a single message.\n\n> **Note:** See [Appendix B of the NIST SP800-38A standard](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf#%5B%7B%22num%22%3A70%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22Fit%22%7D%5D) for more information." }, - "aesgcmparams": { + "AesGcmParams": { "docs": "The **`AesGcmParams`** dictionary of the [Web Crypto API](/en-US/docs/Web/API/Web_Crypto_API) represents the object that should be passed as the `algorithm` parameter into [SubtleCrypto.encrypt], [SubtleCrypto.decrypt], [SubtleCrypto.wrapKey], or [SubtleCrypto.unwrapKey], when using the [AES-GCM](/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-gcm) algorithm.\n\nFor details of how to supply appropriate values for this parameter, see the specification for AES-GCM: [NIST SP800-38D](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf), in particular section 5.2.1.1 on Input Data." }, - "aeskeygenparams": { + "AesKeyGenParams": { "docs": "The **`AesKeyGenParams`** dictionary of the [Web Crypto API](/en-US/docs/Web/API/Web_Crypto_API) represents the object that should be passed as the `algorithm` parameter into [SubtleCrypto.generateKey], when generating an AES key: that is, when the algorithm is identified as any of [AES-CBC](/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-cbc), [AES-CTR](/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-ctr), [AES-GCM](/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-gcm), or [AES-KW](/en-US/docs/Web/API/SubtleCrypto/wrapKey#aes-kw)." }, - "ambientlightsensor": { + "AmbientLightSensor": { "docs": "The **`AmbientLightSensor`** interface of the [Sensor APIs](/en-US/docs/Web/API/Sensor_APIs) returns the current light level or illuminance of the ambient light around the hosting device.\n\nTo use this sensor, the user must grant permission to the `'ambient-light-sensor'` device sensor through the [Permissions API](/en-US/docs/Web/API/Permissions_API).\n\nThis feature may be blocked by a [Permissions Policy](/en-US/docs/Web/HTTP/Permissions_Policy) set on your server.", "properties": { "illuminance": "The **`illuminance`** read-only property of the [AmbientLightSensor] interface returns the current light level in [lux](https://en.wikipedia.org/wiki/Lux) of the ambient light level around the hosting device." } }, - "analysernode": { + "AnalyserNode": { "docs": "The **`AnalyserNode`** interface represents a node able to provide real-time frequency and time-domain analysis information. It is an [AudioNode] that passes the audio stream unchanged from the input to the output, but allows you to take the generated data, process it, and create audio visualizations.\n\nAn `AnalyserNode` has exactly one input and one output. The node works even if the output is not connected.\n\n![Without modifying the audio stream, the node allows to get the frequency and time-domain data associated to it, using a FFT.](fttaudiodata_en.svg)\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Number of inputs1
Number of outputs1 (but may be left unconnected)
Channel count mode\"max\"
Channel count2
Channel interpretation\"speakers\"
", "properties": { "fftsize": "The **`fftSize`** property of the [AnalyserNode] interface is an unsigned long value and represents the window size in samples that is used when performing a [Fast Fourier Transform](https://en.wikipedia.org/wiki/Fast_Fourier_transform) (FFT) to get frequency domain data.", @@ -75,15 +83,7 @@ "smoothingtimeconstant": "The **`smoothingTimeConstant`** property of the [AnalyserNode] interface is a double value representing the averaging constant with the last analysis frame. It's basically an average between the current buffer and the last buffer the `AnalyserNode` processed, and results in a much smoother set of value changes over time." } }, - "angle_instanced_arrays": { - "docs": "The **`ANGLE_instanced_arrays`** extension is part of the [WebGL API](/en-US/docs/Web/API/WebGL_API) and allows to draw the same object, or groups of similar objects multiple times, if they share the same vertex data, primitive count and type.\n\nWebGL extensions are available using the [WebGLRenderingContext.getExtension] method. For more information, see also [Using Extensions](/en-US/docs/Web/API/WebGL_API/Using_Extensions) in the [WebGL tutorial](/en-US/docs/Web/API/WebGL_API/Tutorial).\n\n> **Note:** This extension is only available to [WebGLRenderingContext] contexts. In [WebGL2RenderingContext], the functionality of this extension is available on the WebGL2 context by default and the constants and methods are available without the \"`ANGLE`\" suffix.\n>\n> Despite the name \"ANGLE\", this extension works on any device if the hardware supports it and not just on Windows when using the ANGLE library. \"ANGLE\" just indicates that this extension has been written by the ANGLE library authors.", - "properties": { - "drawarraysinstancedangle": "The **`ANGLE_instanced_arrays.drawArraysInstancedANGLE()`** method of the [WebGL API](/en-US/docs/Web/API/WebGL_API) renders primitives from array data like the [WebGLRenderingContext.drawArrays] method. In addition, it can execute multiple instances of the range of elements.\n\n> **Note:** When using [WebGL2RenderingContext], this method is available as [WebGL2RenderingContext.drawArraysInstanced] by default.", - "drawelementsinstancedangle": "The **`ANGLE_instanced_arrays.drawElementsInstancedANGLE()`** method of the [WebGL API](/en-US/docs/Web/API/WebGL_API) renders primitives from array data like the [WebGLRenderingContext.drawElements] method. In addition, it can execute multiple instances of a set of elements.\n\n> **Note:** When using [WebGL2RenderingContext], this method is available as [WebGL2RenderingContext.drawElementsInstanced] by default.", - "vertexattribdivisorangle": "The **ANGLE_instanced_arrays.vertexAttribDivisorANGLE()** method of the [WebGL API](/en-US/docs/Web/API/WebGL_API) modifies the rate at which generic vertex attributes advance when rendering multiple instances of primitives with [ANGLE_instanced_arrays.drawArraysInstancedANGLE] and [ANGLE_instanced_arrays.drawElementsInstancedANGLE].\n\n> **Note:** When using [WebGL2RenderingContext], this method is available as [WebGL2RenderingContext.vertexAttribDivisor] by default." - } - }, - "animation": { + "Animation": { "docs": "The **`Animation`** interface of the [Web Animations API](/en-US/docs/Web/API/Web_Animations_API) represents a single animation player and provides playback controls and a timeline for an animation node or source.", "properties": { "cancel": "The Web Animations API's **`cancel()`** method of the [Animation] interface clears all [KeyframeEffect]s caused by this animation and aborts its playback.\n\n> **Note:** When an animation is cancelled, its [Animation.startTime] and [Animation.currentTime] are set to `null`.", @@ -110,7 +110,7 @@ "updateplaybackrate": "The **`updatePlaybackRate()`** method of the [Web Animations API](/en-US/docs/Web/API/Web_Animations_API)'s\n[Animation] Interface sets the speed of an animation after first\nsynchronizing its playback position.\n\nIn some cases, an animation may run on a separate thread or process and will continue\nupdating even while long-running JavaScript delays the main thread. In such a case,\nsetting the [Animation.playbackRate] on the animation\ndirectly may cause the animation's playback position to jump since its playback\nposition on the main thread may have drifted from the playback position where it is\ncurrently running.\n\n`updatePlaybackRate()` is an asynchronous method that sets the speed of an\nanimation after synchronizing with its current playback position, ensuring that the\nresulting change in speed does not produce a sharp jump. After calling\n`updatePlaybackRate()` the animation's [Animation.playbackRate] is _not_ immediately updated. It will be updated once the\nanimation's [Animation.ready] promise is resolved." } }, - "animationeffect": { + "AnimationEffect": { "docs": "The `AnimationEffect` interface of the [Web Animations API](/en-US/docs/Web/API/Web_Animations_API) is an interface representing animation effects.\n\n`AnimationEffect` is an abstract interface and so isn't directly instantiable. However, concrete interfaces such as [KeyframeEffect] inherit from it, and instances of these interfaces can be passed to [Animation] objects for playing, and may also be used by [CSS Animations](/en-US/docs/Web/CSS/CSS_animations) and [Transitions](/en-US/docs/Web/CSS/CSS_transitions).", "properties": { "getcomputedtiming": "The `getComputedTiming()` method of the [AnimationEffect] interface returns the calculated timing properties for this animation effect.\n\n> **Note:** These values are comparable to the computed styles of an Element returned using `window.getComputedStyle(elem)`.", @@ -118,7 +118,7 @@ "updatetiming": "The `updateTiming()` method of the [AnimationEffect] interface updates the specified timing properties for an animation effect." } }, - "animationevent": { + "AnimationEvent": { "docs": "The **`AnimationEvent`** interface represents events providing information related to [animations](/en-US/docs/Web/CSS/CSS_animations/Using_CSS_animations).", "properties": { "animationname": "The **`AnimationEvent.animationName`** read-only property is a\nstring containing the value of the CSS\nproperty associated with the transition.", @@ -126,20 +126,20 @@ "pseudoelement": "The **`AnimationEvent.pseudoElement`** read-only property is a\nstring, starting with `'::'`, containing the name of the [pseudo-element](/en-US/docs/Web/CSS/Pseudo-elements) the animation runs on.\nIf the animation doesn't run on a pseudo-element but on the element, an empty string: `''`." } }, - "animationplaybackevent": { + "AnimationPlaybackEvent": { "docs": "The AnimationPlaybackEvent interface of the [Web Animations API](/en-US/docs/Web/API/Web_Animations_API) represents animation events.\n\nAs animations play, they report changes to their [Animation.playState] through animation events.", "properties": { "currenttime": "The **`currentTime`** read-only property of the [AnimationPlaybackEvent] interface represents the current time of the animation that generated the event at the moment the event is queued. This will be unresolved if the animation was `idle` at the time the event was generated.", "timelinetime": "The **`timelineTime`** read-only property of the [AnimationPlaybackEvent] interface represents the time value of the animation's [AnimationTimeline] at the moment the event is queued. This will be unresolved if the animation was not associated with a timeline at the time the event was generated or if the associated timeline was inactive." } }, - "animationtimeline": { + "AnimationTimeline": { "docs": "The `AnimationTimeline` interface of the [Web Animations API](/en-US/docs/Web/API/Web_Animations_API) represents the timeline of an animation. This interface exists to define timeline features, inherited by other timeline types:\n\n- [DocumentTimeline]\n- [ScrollTimeline]\n- [ViewTimeline]", "properties": { "currenttime": "The **`currentTime`** read-only property of the [Web Animations API](/en-US/docs/Web/API/Web_Animations_API)'s [AnimationTimeline] interface returns the timeline's current time in milliseconds, or `null` if the timeline is inactive." } }, - "attr": { + "Attr": { "docs": "The **`Attr`** interface represents one of an element's attributes as an object. In most situations, you will directly retrieve the attribute value as a string (e.g., [Element.getAttribute]), but some cases may require interacting with `Attr` instances (e.g., [Element.getAttributeNode]).\n\nThe core idea of an object of type `Attr` is the association between a _name_ and a _value_. An attribute may also be part of a _namespace_ and, in this case, it also has a URI identifying the namespace, and a prefix that is an abbreviation for the namespace.\n\nThe name is deemed _local_ when it ignores the eventual namespace prefix and deemed _qualified_ when it includes the prefix of the namespace, if any, separated from the local name by a colon (`:`). We have three cases: an attribute outside of a namespace, an attribute inside a namespace without a prefix defined, an attribute inside a namespace with a prefix:\n\n| Attribute | Namespace name | Namespace prefix | Attribute local name | Attribute qualified name |\n| --------- | -------------- | ---------------- | -------------------- | ------------------------ |\n| `myAttr` | _none_ | _none_ | `myAttr` | `myAttr` |\n| `myAttr` | `mynamespace` | _none_ | `myAttr` | `myAttr` |\n| `myAttr` | `mynamespace` | `myns` | `myAttr` | `myns:myAttr` |\n\n> **Note:** This interface represents only attributes present in the tree representation of the [Element], being a SVG, an HTML or a MathML element. It doesn't represent the _property_ of an interface associated with such element, such as [HTMLTableElement] for a `table` element. (See for more information about attributes and how they are _reflected_ into properties.)", "properties": { "localname": "The read-only **`localName`** property of the [Attr] interface returns the _local part_ of the _qualified name_ of an attribute, that is the name of the attribute, stripped from any namespace in front of it. For example, if the qualified name is `xml:lang`, the returned local name is `lang`, if the element supports that namespace.\n\nThe local name is always in lower case, whatever case at the attribute creation.\n\n> **Note:** HTML only supports a fixed set of namespaces on SVG and MathML elements. These are `xml` (for the `xml:lang` attribute), `xlink` (for the `xlink:href`, `xlink:show`, `xlink:target` and `xlink:title` attributes) and `xpath`.\n>\n> That means that the local name of an attribute of an HTML element is always be equal to its qualified name: Colons are treated as regular characters. In XML, like in SVG or MathML, the colon denotes the end of the prefix and what is before is the namespace; the local name may be different from the qualified name.", @@ -151,7 +151,7 @@ "value": "The **`value`** property of the [Attr] interface contains the value of the attribute." } }, - "audiobuffer": { + "AudioBuffer": { "docs": "The **`AudioBuffer`** interface represents a short audio asset residing in memory, created from an audio file using the [BaseAudioContext/decodeAudioData] method, or from raw data using [BaseAudioContext/createBuffer]. Once put into an AudioBuffer, the audio can then be played by being passed into an [AudioBufferSourceNode].\n\nObjects of these types are designed to hold small audio snippets, typically less than 45 s. For longer sounds, objects implementing the [MediaElementAudioSourceNode] are more suitable. The buffer contains the audio signal waveform encoded as a series of amplitudes in the following format: non-interleaved IEEE754 32-bit linear PCM with a nominal range between `-1` and `+1`, that is, a 32-bit floating point buffer, with each sample between -1.0 and 1.0. If the [AudioBuffer] has multiple channels, they are stored in separate buffers.", "properties": { "copyfromchannel": "The\n**`copyFromChannel()`** method of the\n[AudioBuffer] interface copies the audio sample data from the specified\nchannel of the `AudioBuffer` to a specified\n`Float32Array`.", @@ -163,7 +163,7 @@ "samplerate": "The **`sampleRate`** property of the [AudioBuffer] interface returns a float representing the sample rate, in\nsamples per second, of the PCM data stored in the buffer." } }, - "audiobuffersourcenode": { + "AudioBufferSourceNode": { "docs": "The **`AudioBufferSourceNode`** interface is an [AudioScheduledSourceNode] which represents an audio source consisting of in-memory audio data, stored in an [AudioBuffer].\n\nThis interface is especially useful for playing back audio which has particularly stringent timing accuracy requirements, such as for sounds that must match a specific rhythm and can be kept in memory rather than being played from disk or the network. To play sounds which require accurate timing but must be streamed from the network or played from disk, use a [AudioWorkletNode] to implement its playback.\n\nAn `AudioBufferSourceNode` has no inputs and exactly one output, which has the same number of channels as the `AudioBuffer` indicated by its [AudioBufferSourceNode.buffer] property. If there's no buffer set—that is, if `buffer` is `null`—the output contains a single channel of silence (every sample is 0).\n\nAn `AudioBufferSourceNode` can only be played once; after each call to [AudioBufferSourceNode.start], you have to create a new node if you want to play the same sound again. Fortunately, these nodes are very inexpensive to create, and the actual `AudioBuffer`s can be reused for multiple plays of the sound. Indeed, you can use these nodes in a \"fire and forget\" manner: create the node, call `start()` to begin playing the sound, and don't even bother to hold a reference to it. It will automatically be garbage-collected at an appropriate time, which won't be until sometime after the sound has finished playing.\n\nMultiple calls to [AudioScheduledSourceNode/stop] are allowed. The most recent call replaces the previous one, if the `AudioBufferSourceNode` has not already reached the end of the buffer.\n\n![The AudioBufferSourceNode takes the content of an AudioBuffer and m](webaudioaudiobuffersourcenode.png)\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Number of inputs0
Number of outputs1
Channel countdefined by the associated [AudioBuffer]
", "properties": { "buffer": "The **`buffer`** property of the [AudioBufferSourceNode] interface provides the ability to play back audio\nusing an [AudioBuffer] as the source of the sound data.\n\nIf the `buffer` property is set to the value `null`, the node\ngenerates a single channel containing silence (that is, every sample is 0).", @@ -175,7 +175,7 @@ "start": "The `start()` method of the [AudioBufferSourceNode]\nInterface is used to schedule playback of the audio data contained in the buffer, or\nto begin playback immediately." } }, - "audiocontext": { + "AudioContext": { "docs": "The `AudioContext` interface represents an audio-processing graph built from audio modules linked together, each represented by an [AudioNode].\n\nAn audio context controls both the creation of the nodes it contains and the execution of the audio processing, or decoding. You need to create an `AudioContext` before you do anything else, as everything happens inside a context. It's recommended to create one AudioContext and reuse it instead of initializing a new one each time, and it's OK to use a single `AudioContext` for several different audio sources and pipeline concurrently.", "properties": { "baselatency": "The **`baseLatency`** read-only property of the\n[AudioContext] interface returns a double that represents the number of\nseconds of processing latency incurred by the `AudioContext` passing an audio\nbuffer from the [AudioDestinationNode] — i.e. the end of the audio graph —\ninto the host system's audio subsystem ready for playing.\n\n> **Note:** You can request a certain latency during\n> [AudioContext.AudioContext] with the\n> `latencyHint` option, but the browser may ignore the option.", @@ -193,7 +193,7 @@ "suspend": "The `suspend()` method of the [AudioContext] Interface suspends the progression of time in the audio context, temporarily halting audio hardware access and reducing CPU/battery usage in the process — this is useful if you want an application to power down the audio hardware when it will not be using an audio context for a while.\n\nThis method will cause an `INVALID_STATE_ERR` exception to be thrown if called on an [OfflineAudioContext]." } }, - "audiodata": { + "AudioData": { "docs": "The **`AudioData`** interface of the [WebCodecs API](/en-US/docs/Web/API/WebCodecs_API) represents an audio sample.\n\n`AudioData` is a [transferable object](/en-US/docs/Web/API/Web_Workers_API/Transferable_objects).", "properties": { "allocationsize": "The **`allocationSize()`** method of the [AudioData] interface returns the size in bytes required to hold the current sample as filtered by options passed into the method.", @@ -208,7 +208,7 @@ "timestamp": "The **`duration`** read-only property of the [AudioData] interface returns the timestamp of this `AudioData` object." } }, - "audiodecoder": { + "AudioDecoder": { "docs": "The **`AudioDecoder`** interface of the [WebCodecs API] decodes chunks of audio.", "properties": { "close": "The **`close()`** method of the [AudioDecoder] interface ends all pending work and releases system resources.", @@ -222,13 +222,13 @@ "state": "The **`state`** read-only property of the [AudioDecoder] interface returns the current state of the underlying codec." } }, - "audiodestinationnode": { + "AudioDestinationNode": { "docs": "The `AudioDestinationNode` interface represents the end destination of an audio graph in a given context — usually the speakers of your device. It can also be the node that will \"record\" the audio data when used with an `OfflineAudioContext`.\n\n`AudioDestinationNode` has no output (as it _is_ the output, no more `AudioNode` can be linked after it in the audio graph) and one input. The number of channels in the input must be between `0` and the `maxChannelCount` value or an exception is raised.\n\nThe `AudioDestinationNode` of a given `AudioContext` can be retrieved using the [BaseAudioContext/destination] property.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Number of inputs1
Number of outputs0
Channel count mode\"explicit\"
Channel count2
Channel interpretation\"speakers\"
", "properties": { "maxchannelcount": "The `maxchannelCount` property of the [AudioDestinationNode] interface is an `unsigned long` defining the maximum amount of channels that the physical device can handle.\n\nThe [AudioNode.channelCount] property can be set between 0 and this value (both included). If `maxChannelCount` is `0`, like in [OfflineAudioContext], the channel count cannot be changed." } }, - "audioencoder": { + "AudioEncoder": { "docs": "The **`AudioEncoder`** interface of the [WebCodecs API](/en-US/docs/Web/API/WebCodecs_API) encodes [AudioData] objects.", "properties": { "close": "The **`close()`** method of the [AudioEncoder] interface ends all pending work and releases system resources.", @@ -242,7 +242,7 @@ "state": "The **`state`** read-only property of the [AudioEncoder] interface returns the current state of the underlying codec." } }, - "audiolistener": { + "AudioListener": { "docs": "The `AudioListener` interface represents the position and orientation of the unique person listening to the audio scene, and is used in [audio spatialization](/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics). All [PannerNode]s spatialize in relation to the `AudioListener` stored in the [BaseAudioContext.listener] attribute.\n\nIt is important to note that there is only one listener per context and that it isn't an [AudioNode].\n\n![We see the position, up and front vectors of an AudioListener, with the up and front vectors at 90° from the other.](webaudiolistenerreduced.png)", "properties": { "forwardx": "The `forwardX` read-only property of the [AudioListener] interface is an [AudioParam] representing the x value of the direction vector defining the forward direction the listener is pointing in.\n\n> **Note:** The parameter is _a-rate_ when used with a [PannerNode] whose [PannerNode.panningModel] is set to equalpower, or _k-rate_ otherwise.", @@ -258,7 +258,7 @@ "upz": "The `upZ` read-only property of the [AudioListener] interface is an [AudioParam] representing the z value of the direction vector defining the up direction the listener is pointing in.\n\n> **Note:** The parameter is _a-rate_ when used with a [PannerNode] whose [PannerNode.panningModel] is set to equalpower, or _k-rate_ otherwise." } }, - "audionode": { + "AudioNode": { "docs": "The **`AudioNode`** interface is a generic interface for representing an audio processing module.\n\nExamples include:\n\n- an audio source (e.g. an HTML `audio` or `video` element, an [OscillatorNode], etc.),\n- the audio destination,\n- intermediate processing module (e.g. a filter like [BiquadFilterNode] or [ConvolverNode]), or\n- volume control (like [GainNode])\n\n> **Note:** An `AudioNode` can be target of events, therefore it implements the [EventTarget] interface.", "properties": { "channelcount": "The **`channelCount`** property of the [AudioNode] interface represents an integer used to determine how many channels are used when [up-mixing and down-mixing](/en-US/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API#up-mixing_and_down-mixing) connections to any inputs to the node.\n\n`channelCount`'s usage and precise definition depend on the value of [AudioNode.channelCountMode]:\n\n- It is ignored if the `channelCountMode` value is `max`.\n- It is used as a maximum value if the `channelCountMode` value is `clamped-max`.\n- It is used as the exact value if the `channelCountMode` value is `explicit`.", @@ -271,7 +271,7 @@ "numberofoutputs": "The `numberOfOutputs` property of\nthe [AudioNode] interface returns the number of outputs coming out of\nthe node. Destination nodes — like [AudioDestinationNode] — have\na value of 0 for this attribute." } }, - "audioparam": { + "AudioParam": { "docs": "The Web Audio API's `AudioParam` interface represents an audio-related parameter, usually a parameter of an [AudioNode] (such as [GainNode.gain]).\n\nAn `AudioParam` can be set to a specific value or a change in value, and can be scheduled to happen at a specific time and following a specific pattern.\n\nEach `AudioParam` has a list of events, initially empty, that define when and how values change. When this list is not empty, changes using the `AudioParam.value` attributes are ignored. This list of events allows us to schedule changes that have to happen at very precise times, using arbitrary timeline-based automation curves. The time used is the one defined in [BaseAudioContext/currentTime].", "properties": { "cancelandholdattime": "The **`cancelAndHoldAtTime()`** method of the\n[AudioParam] interface cancels all scheduled future changes to the\n`AudioParam` but holds its value at a given time until further changes are\nmade using other methods.", @@ -287,13 +287,13 @@ "value": "The [Web Audio API's](/en-US/docs/Web/API/Web_Audio_API)\n[AudioParam] interface property **`value`** gets\nor sets the value of this [AudioParam] at the current time. Initially, the value is set to [AudioParam.defaultValue].\n\nSetting `value` has the same effect as\ncalling [AudioParam.setValueAtTime] with the time returned by the\n`AudioContext`'s [BaseAudioContext/currentTime]\nproperty." } }, - "audioparamdescriptor": { + "AudioParamDescriptor": { "docs": "The **`AudioParamDescriptor`** dictionary of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) specifies properties for [AudioParam] objects.\n\nIt is used to create custom `AudioParam`s on an [AudioWorkletNode]. If the underlying [AudioWorkletProcessor] has a [AudioWorkletProcessor.parameterDescriptors] static getter, then the returned array of objects based on this dictionary is used internally by `AudioWorkletNode` constructor to populate its [AudioWorkletNode.parameters] property accordingly." }, - "audioparammap": { + "AudioParamMap": { "docs": "The **`AudioParamMap`** interface of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) represents an iterable and read-only set of multiple audio parameters.\n\nAn `AudioParamMap` instance is a read-only [`Map`-like object](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map#map-like_browser_apis), in which each key is the name string for a parameter, and the corresponding value is an [AudioParam] containing the value of that parameter." }, - "audioprocessingevent": { + "AudioProcessingEvent": { "docs": "The `AudioProcessingEvent` interface of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) represents events that occur when a [ScriptProcessorNode] input buffer is ready to be processed.\n\nAn `audioprocess` event with this interface is fired on a [ScriptProcessorNode] when audio processing is required. During audio processing, the input buffer is read and processed to produce output audio data, which is then written to the output buffer.\n\n> **Warning:** This feature has been deprecated and should be replaced by an [`AudioWorklet`](/en-US/docs/Web/API/AudioWorklet).", "properties": { "inputbuffer": "The **`inputBuffer`** read-only property of the [AudioProcessingEvent] interface represents the input buffer of an audio processing event.\n\nThe input buffer is represented by an [AudioBuffer] object, which contains a collection of audio channels, each of which is an array of floating-point values representing the audio signal waveform encoded as a series of amplitudes. The number of channels and the length of each channel are determined by the channel count and buffer size properties of the `AudioBuffer`.", @@ -301,7 +301,7 @@ "playbacktime": "The **`playbackTime`** read-only property of the [AudioProcessingEvent] interface represents the time when the audio will be played. It is in the same coordinate system as the time used by the [AudioContext]." } }, - "audioscheduledsourcenode": { + "AudioScheduledSourceNode": { "docs": "The `AudioScheduledSourceNode` interface—part of the Web Audio API—is a parent interface for several types of audio source node interfaces which share the ability to be started and stopped, optionally at specified times. Specifically, this interface defines the [AudioScheduledSourceNode.start] and [AudioScheduledSourceNode.stop] methods, as well as the [AudioScheduledSourceNode.ended_event] event.\n\n> **Note:** You can't create an `AudioScheduledSourceNode` object directly. Instead, use an interface which extends it, such as [AudioBufferSourceNode], [OscillatorNode] or [ConstantSourceNode].\n\nUnless stated otherwise, nodes based upon `AudioScheduledSourceNode` output silence when not playing (that is, before `start()` is called and after `stop()` is called). Silence is represented, as always, by a stream of samples with the value zero (0).", "properties": { "ended_event": "The `ended` event of the [AudioScheduledSourceNode] interface is fired when the source node has stopped playing.\n\nThis event occurs when a [AudioScheduledSourceNode] has stopped playing, either because it's reached a predetermined stop time, the full duration of the audio has been performed, or because the entire buffer has been played.\n\nThis event is not cancelable and does not bubble.", @@ -309,13 +309,13 @@ "stop": "The `stop()` method on [AudioScheduledSourceNode] schedules a\nsound to cease playback at the specified time. If no time is specified, then the sound\nstops playing immediately.\n\nEach time you call `stop()` on the same node, the specified time replaces\nany previously-scheduled stop time that hasn't occurred yet. If the node has already\nstopped, this method has no effect.\n\n> **Note:** If a scheduled stop time occurs before the node's scheduled\n> start time, the node never starts to play." } }, - "audiosinkinfo": { + "AudioSinkInfo": { "docs": "The **`AudioSinkInfo`** interface of the [Web Audio API] represents information describing an [AudioContext]'s sink ID, retrieved via [AudioContext.sinkId].", "properties": { "type": "The **`type`** read-only property of the [AudioSinkInfo] interface returns the type of the audio output device." } }, - "audiotrack": { + "AudioTrack": { "docs": "The **`AudioTrack`** interface represents a single audio track from one of the HTML media elements, `audio` or `video`.\n\nThe most common use for accessing an `AudioTrack` object is to toggle its [AudioTrack.enabled] property in order to mute and unmute the track.", "properties": { "enabled": "The **[AudioTrack]** property\n**`enabled`** specifies whether or not the described audio\ntrack is currently enabled for use. If the track is disabled by setting\n`enabled` to `false`, the track is muted and does not produce\naudio.", @@ -326,7 +326,7 @@ "sourcebuffer": "The read-only **[AudioTrack]**\nproperty **`sourceBuffer`** returns the\n[SourceBuffer] that created the track, or null if the track was not\ncreated by a [SourceBuffer] or the [SourceBuffer] has been\nremoved from the [MediaSource.sourceBuffers] attribute of its parent\nmedia source." } }, - "audiotracklist": { + "AudioTrackList": { "docs": "The **`AudioTrackList`** interface is used to represent a list of the audio tracks contained within a given HTML media element, with each track represented by a separate [AudioTrack] object in the list.\n\nRetrieve an instance of this object with [HTMLMediaElement.audioTracks]. The individual tracks can be accessed using array syntax.", "properties": { "addtrack_event": "The `addtrack` event is fired when a track is added to an [`AudioTrackList`](/en-US/docs/Web/API/AudioTrackList).", @@ -336,10 +336,10 @@ "removetrack_event": "The `removetrack` event is fired when a track is removed from an [`AudioTrackList`](/en-US/docs/Web/API/AudioTrackList)." } }, - "audioworklet": { + "AudioWorklet": { "docs": "The **`AudioWorklet`** interface of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) is used to supply custom audio processing scripts that execute in a separate thread to provide very low latency audio processing.\n\nThe worklet's code is run in the [AudioWorkletGlobalScope] global execution context, using a separate Web Audio thread which is shared by the worklet and other audio nodes.\n\nAccess the audio context's instance of `AudioWorklet` through the [BaseAudioContext.audioWorklet] property." }, - "audioworkletglobalscope": { + "AudioWorkletGlobalScope": { "docs": "The **`AudioWorkletGlobalScope`** interface of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) represents a global execution context for user-supplied code, which defines custom [AudioWorkletProcessor]-derived classes.\n\nEach [BaseAudioContext] has a single [AudioWorklet] available under the [BaseAudioContext.audioWorklet] property, which runs its code in a single `AudioWorkletGlobalScope`.\n\nAs the global execution context is shared across the current `BaseAudioContext`, it's possible to define any other variables and perform any actions allowed in worklets — apart from defining `AudioWorkletProcessor` derived classes.", "properties": { "currentframe": "The read-only **`currentFrame`** property of the [AudioWorkletGlobalScope] interface returns an integer that represents the ever-increasing current sample-frame of the audio block being processed. It is incremented by 128 (the size of a render quantum) after the processing of each audio block.", @@ -348,7 +348,7 @@ "samplerate": "The read-only **`sampleRate`** property of the [AudioWorkletGlobalScope] interface returns a float that represents the sample rate of the associated [BaseAudioContext] the worklet belongs to." } }, - "audioworkletnode": { + "AudioWorkletNode": { "docs": "> **Note:** Although the interface is available outside [secure contexts](/en-US/docs/Web/Security/Secure_Contexts), the [BaseAudioContext.audioWorklet] property is not, thus custom [AudioWorkletProcessor]s cannot be defined outside them.\n\nThe **`AudioWorkletNode`** interface of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) represents a base class for a user-defined [AudioNode], which can be connected to an audio routing graph along with other nodes. It has an associated [AudioWorkletProcessor], which does the actual audio processing in a Web Audio rendering thread.", "properties": { "parameters": "The read-only **`parameters`** property of the\n[AudioWorkletNode] interface returns the associated\n[AudioParamMap] — that is, a `Map`-like collection of\n[AudioParam] objects. They are instantiated during creation of the\nunderlying [AudioWorkletProcessor] according to its\n[AudioWorkletProcessor.parameterDescriptors] static\ngetter.", @@ -356,7 +356,7 @@ "processorerror_event": "The `processorerror` event fires when the underlying [AudioWorkletProcessor] behind the node throws an exception in its constructor, the [AudioWorkletProcessor.process] method, or any user-defined class method.\n\nOnce an exception is thrown, the processor (and thus the node) will output silence throughout its lifetime." } }, - "audioworkletprocessor": { + "AudioWorkletProcessor": { "docs": "The **`AudioWorkletProcessor`** interface of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) represents an audio processing code behind a custom [AudioWorkletNode]. It lives in the [AudioWorkletGlobalScope] and runs on the Web Audio rendering thread. In turn, an [AudioWorkletNode] based on it runs on the main thread.", "properties": { "parameterdescriptors": "The read-only **`parameterDescriptors`** property of an [AudioWorkletProcessor]-derived class is a _static getter_,\nwhich returns an iterable of [AudioParamDescriptor]-based objects.\n\nThe property is not a part of the [AudioWorkletProcessor]\ninterface, but, if defined, it is called internally by the\n[AudioWorkletProcessor] constructor to create a list of custom\n[AudioParam] objects in the [AudioWorkletNode.parameters] property of the associated [AudioWorkletNode].\n\nDefining the getter is optional.", @@ -364,7 +364,7 @@ "process": "The **`process()`**\nmethod of an [AudioWorkletProcessor]-derived class implements the audio\nprocessing algorithm for the audio processor worklet.\n\nAlthough the method is\nnot a part of the [AudioWorkletProcessor] interface, any implementation\nof `AudioWorkletProcessor` must provide a `process()` method.\n\nThe method is called synchronously from the audio rendering thread, once for each block\nof audio (also known as a rendering quantum) being directed through the processor's\ncorresponding [AudioWorkletNode]. In other words, every time a new block of\naudio is ready for your processor to manipulate, your `process()` function is\ninvoked to do so.\n\n> **Note:** Currently, audio data blocks are always 128 frames\n> long—that is, they contain 128 32-bit floating-point samples for each of the inputs'\n> channels. However, plans are already in place to revise the specification to allow the\n> size of the audio blocks to be changed depending on circumstances (for example, if the\n> audio hardware or CPU utilization is more efficient with larger block sizes).\n> Therefore, you _must always check the size of the sample array_ rather than\n> assuming a particular size.\n>\n> This size may even be allowed to change over time, so you mustn't look at just the\n> first block and assume the sample buffers will always be the same size." } }, - "authenticatorassertionresponse": { + "AuthenticatorAssertionResponse": { "docs": "The **`AuthenticatorAssertionResponse`** interface of the [Web Authentication API](/en-US/docs/Web/API/Web_Authentication_API) contains a [digital signature](/en-US/docs/Glossary/Signature/Security) from the private key of a particular WebAuthn credential. The relying party's server can verify this signature to authenticate a user, for example when they sign in.\n\nAn `AuthenticatorAssertionResponse` object instance is available in the [PublicKeyCredential.response] property of a [PublicKeyCredential] object returned by a successful [CredentialsContainer.get] call.\n\nThis interface inherits from [AuthenticatorResponse].\n\n> **Note:** This interface is restricted to top-level contexts. Use from within an `iframe` element will not have any effect.", "properties": { "authenticatordata": "The **`authenticatorData`** property of the [AuthenticatorAssertionResponse] interface returns an `ArrayBuffer` containing information from the authenticator such as the Relying Party ID Hash (rpIdHash), a signature counter, test of user presence, user verification flags, and any extensions processed by the authenticator.", @@ -372,7 +372,7 @@ "userhandle": "The **`userHandle`** read-only property of the [AuthenticatorAssertionResponse] interface is an `ArrayBuffer` object providing an opaque identifier for the given user. Such an identifier can be used by the relying party's server to link the user account with its corresponding credentials and other data.\n\nThis value is specified as `user.id` in the options passed to the originating [CredentialsContainer.create] call." } }, - "authenticatorattestationresponse": { + "AuthenticatorAttestationResponse": { "docs": "The **`AuthenticatorAttestationResponse`** interface of the [Web Authentication API](/en-US/docs/Web/API/Web_Authentication_API) is the result of a WebAuthn credential registration. It contains information about the credential that the server needs to perform WebAuthn assertions, such as its credential ID and public key.\n\nAn `AuthenticatorAttestationResponse` object instance is available in the [PublicKeyCredential.response] property of a [PublicKeyCredential] object returned by a successful [CredentialsContainer.create] call.\n\nThis interface inherits from [AuthenticatorResponse].\n\n> **Note:** This interface is restricted to top-level contexts. Use of its features from within an `iframe` element will not have any effect.", "properties": { "attestationobject": "The **`attestationObject`** property of the\n[AuthenticatorAttestationResponse] interface returns an\n`ArrayBuffer` containing the new public key, as well as signature over the\nentire `attestationObject` with a private key that is stored in the\nauthenticator when it is manufactured.\n\nAs part of the [CredentialsContainer.create] call, an authenticator will\ncreate a new keypair as well as an `attestationObject` for that keypair. The public key\nthat corresponds to the private key that has created the attestation signature is well\nknown; however, there are various well known attestation public key chains for different\necosystems (for example, Android or TPM attestations).", @@ -382,19 +382,19 @@ "gettransports": "The **`getTransports()`** method of the [AuthenticatorAttestationResponse] interface returns an array of strings describing the different transports which may be used by the authenticator.\n\nSuch transports may be USB, NFC, BLE, internal (applicable when the authenticator is not removable from the device), or a hybrid approach. Sites should not interpret this array but instead store it along with the rest of the credential information. In a subsequent [CredentialsContainer.get] call, the `transports` value(s) specified inside `publicKey.allowCredentials` should be set to the stored array value. This provides a hint to the browser as to which types of authenticators to try when making an assertion for this credential." } }, - "authenticatorresponse": { + "AuthenticatorResponse": { "docs": "The **`AuthenticatorResponse`** interface of the [Web Authentication API](/en-US/docs/Web/API/Web_Authentication_API) is the base interface for interfaces that provide a cryptographic root of trust for a key pair. The child interfaces include information from the browser such as the challenge origin and either may be returned from [PublicKeyCredential.response].", "properties": { "clientdatajson": "The **`clientDataJSON`** property of the [AuthenticatorResponse] interface stores a [JSON](/en-US/docs/Learn/JavaScript/Objects/JSON) string in an\n`ArrayBuffer`, representing the client data that was passed to [CredentialsContainer.create] or [CredentialsContainer.get]. This property is only accessed on one of the child objects of `AuthenticatorResponse`, specifically [AuthenticatorAttestationResponse] or [AuthenticatorAssertionResponse]." } }, - "backgroundfetchevent": { + "BackgroundFetchEvent": { "docs": "The **`BackgroundFetchEvent`** interface of the [Background Fetch API] is the event type for background fetch events dispatched on the [ServiceWorkerGlobalScope].\n\nIt is the event type passed to `onbackgroundfetchabort` and `onbackgroundfetchclick`.", "properties": { "registration": "The **`registration`** read-only property of the [BackgroundFetchEvent] interface returns a [BackgroundFetchRegistration] object." } }, - "backgroundfetchmanager": { + "BackgroundFetchManager": { "docs": "The **`BackgroundFetchManager`** interface of the [Background Fetch API] is a map where the keys are background fetch IDs and the values are [BackgroundFetchRegistration] objects.", "properties": { "fetch": "The **`fetch()`** method of the [BackgroundFetchManager] interface initiates a background fetch operation, given one or more URLs or [Request] objects.", @@ -402,14 +402,14 @@ "getids": "The **`getIds()`** method of the [BackgroundFetchManager] interface returns the IDs of all registered background fetches." } }, - "backgroundfetchrecord": { + "BackgroundFetchRecord": { "docs": "The **`BackgroundFetchRecord`** interface of the [Background Fetch API] represents an individual request and response.\n\nA `BackgroundFetchRecord` is created by the [BackgroundFetchRegistration.match] method, therefore there is no constructor for this interface.\n\nThere will be one `BackgroundFetchRecord` for each resource requested by `fetch()`.", "properties": { "request": "The **`request`** read-only property of the [BackgroundFetchRecord] interface returns the details of the resource to be fetched.", "responseready": "The **`responseReady`** read-only property of the [BackgroundFetchRecord] interface returns a `Promise` that resolves with a [Response]." } }, - "backgroundfetchregistration": { + "BackgroundFetchRegistration": { "docs": "The **`BackgroundFetchRegistration`** interface of the [Background Fetch API] represents an individual background fetch.\n\nA `BackgroundFetchRegistration` instance is returned by the [BackgroundFetchManager.fetch] or [BackgroundFetchManager.get] methods, and therefore there has no constructor.", "properties": { "abort": "The **`abort()`** method of the [BackgroundFetchRegistration] interface aborts an active background fetch.", @@ -426,26 +426,26 @@ "uploadtotal": "The **`uploadTotal`** read-only property of the [BackgroundFetchRegistration] interface returns the total number of bytes to be sent to the server." } }, - "backgroundfetchupdateuievent": { + "BackgroundFetchUpdateUIEvent": { "docs": "The **`BackgroundFetchUpdateUIEvent`** interface of the [Background Fetch API] is an event type for the [ServiceWorkerGlobalScope.backgroundfetchsuccess_event] and [ServiceWorkerGlobalScope.backgroundfetchfail_event] events, and provides a method for updating the title and icon of the app to inform a user of the success or failure of a background fetch.", "properties": { "updateui": "The **`updateUI()`** method of the [BackgroundFetchUpdateUIEvent] interface updates the title and icon in the user interface to show the status of a background fetch.\n\nThis method may only be run once, to notify the user on a failed or a successful fetch." } }, - "barcodedetector": { - "docs": "The **`BarcodeDetector`** interface of the [Barcode Detection API] allows detection of linear and two dimensional barcodes in images.", + "BarProp": { + "docs": "The **`BarProp`** interface of the [Document Object Model] represents the web browser user interface elements that are exposed to scripts in web pages. Each of the following interface elements are represented by a `BarProp` object.\n\n- [Window.locationbar]\n - : The browser location bar.\n- [Window.menubar]\n - : The browser menu bar.\n- [Window.personalbar]\n - : The browser personal bar.\n- [Window.scrollbars]\n - : The browser scrollbars.\n- [Window.statusbar]\n - : The browser status bar.\n- [Window.toolbar]\n - : The browser toolbar.\n\nThe `BarProp` interface is not accessed directly, but via one of these elements.", "properties": { - "detect": "The **`detect()`** method of the\n[BarcodeDetector] interface returns a `Promise` which fulfills\nwith an `Array` of detected barcodes within an image.", - "getsupportedformats_static": "The **`getSupportedFormats()`** static method\nof the [BarcodeDetector] interface returns a `Promise` which\nfulfills with an `Array` of supported barcode format types." + "visible": "The **`visible`** read-only property of the [BarProp] interface returns `true` if the user interface element it represents is visible." } }, - "barprop": { - "docs": "The **`BarProp`** interface of the [Document Object Model] represents the web browser user interface elements that are exposed to scripts in web pages. Each of the following interface elements are represented by a `BarProp` object.\n\n- [Window.locationbar]\n - : The browser location bar.\n- [Window.menubar]\n - : The browser menu bar.\n- [Window.personalbar]\n - : The browser personal bar.\n- [Window.scrollbars]\n - : The browser scrollbars.\n- [Window.statusbar]\n - : The browser status bar.\n- [Window.toolbar]\n - : The browser toolbar.\n\nThe `BarProp` interface is not accessed directly, but via one of these elements.", + "BarcodeDetector": { + "docs": "The **`BarcodeDetector`** interface of the [Barcode Detection API] allows detection of linear and two dimensional barcodes in images.", "properties": { - "visible": "The **`visible`** read-only property of the [BarProp] interface returns `true` if the user interface element it represents is visible." + "detect": "The **`detect()`** method of the\n[BarcodeDetector] interface returns a `Promise` which fulfills\nwith an `Array` of detected barcodes within an image.", + "getsupportedformats_static": "The **`getSupportedFormats()`** static method\nof the [BarcodeDetector] interface returns a `Promise` which\nfulfills with an `Array` of supported barcode format types." } }, - "baseaudiocontext": { + "BaseAudioContext": { "docs": "The `BaseAudioContext` interface of the [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) acts as a base definition for online and offline audio-processing graphs, as represented by [AudioContext] and [OfflineAudioContext] respectively. You wouldn't use `BaseAudioContext` directly — you'd use its features via one of these two inheriting interfaces.\n\nA `BaseAudioContext` can be a target of events, therefore it implements the [EventTarget] interface.", "properties": { "audioworklet": "The `audioWorklet` read-only property of the\n[BaseAudioContext] interface returns an instance of\n[AudioWorklet] that can be used for adding\n[AudioWorkletProcessor]-derived classes which implement custom audio\nprocessing.", @@ -476,7 +476,7 @@ "statechange_event": "A `statechange` event is fired at a [BaseAudioContext] object when its [BaseAudioContext.state] member changes." } }, - "batterymanager": { + "BatteryManager": { "docs": "The `BatteryManager` interface of the [Battery Status API] provides information about the system's battery charge level. The [navigator.getBattery] method returns a promise that resolves with a `BatteryManager` interface.\n\nSince Chrome 103, the `BatteryManager` interface of [Battery Status API] only expose to secure context.", "properties": { "charging": "The **`BatteryManager.charging`** property is a Boolean value indicating whether or not the device's battery is currently being charged. When its value changes, the [BatteryManager/chargingchange_event] event is fired.\n\nIf the battery is charging or the user agent is unable to report the battery status information, this value is `true`. Otherwise, it is `false`.", @@ -489,7 +489,7 @@ "levelchange_event": "The **`levelchange`** event of the [Battery Status API] is fired when the battery [BatteryManager.level] property is updated." } }, - "beforeinstallpromptevent": { + "BeforeInstallPromptEvent": { "docs": "The **`BeforeInstallPromptEvent`** is the interface of the [Window.beforeinstallprompt_event] event fired at the [Window] object before a user is prompted to \"install\" a website to a home screen on mobile.\n\nThis interface inherits from the [Event] interface.", "properties": { "platforms": "The **`platforms`** property of the [BeforeInstallPromptEvent] interface lists the platforms on which the event was dispatched. This is provided for user agents that want to present a choice of versions to the user such as, for example, \"web\" or \"play\" which would allow the user to choose between a web version or an Android version.", @@ -497,13 +497,13 @@ "userchoice": "The **`userChoice`** property of the [BeforeInstallPromptEvent] interface represents the installation choice that the user made, when they were prompted to install the app." } }, - "beforeunloadevent": { + "BeforeUnloadEvent": { "docs": "The **`BeforeUnloadEvent`** interface represents the event object for the [Window/beforeunload_event] event, which is fired when the current window, contained document, and associated resources are about to be unloaded.\n\nSee the [Window/beforeunload_event] event reference for detailed guidance on using this event.", "properties": { "returnvalue": "The **`returnValue`** property of the\n[BeforeUnloadEvent] interface, when set to a truthy value, triggers a browser-generated confirmation dialog asking users to confirm if they _really_ want to leave the page when they try to close or reload it, or navigate somewhere else. This is intended to help prevent loss of unsaved data.\n\n> **Note:** `returnValue` is a legacy feature, and best practice is to trigger the dialog by invoking [Event.preventDefault] on the `BeforeUnloadEvent` object, while also setting `returnValue` to support legacy cases. See the [Window/beforeunload_event] event reference for detailed up-to-date guidance." } }, - "biquadfilternode": { + "BiquadFilterNode": { "docs": "The `BiquadFilterNode` interface represents a simple low-order filter, and is created using the [BaseAudioContext/createBiquadFilter] method. It is an [AudioNode] that can represent different kinds of filters, tone control devices, and graphic equalizers. A `BiquadFilterNode` always has exactly one input and one output.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Number of inputs1
Number of outputs1
Channel count mode\"max\"
Channel count2 (not used in the default count mode)
Channel interpretation\"speakers\"
", "properties": { "detune": "The `detune` property of the [BiquadFilterNode] interface is an [a-rate](/en-US/docs/Web/API/AudioParam#a-rate) [AudioParam] representing detuning of the frequency in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).", @@ -514,7 +514,7 @@ "type": "The `type` property of the [BiquadFilterNode] interface is a string (enum) value defining the kind of filtering algorithm the node is implementing." } }, - "blob": { + "Blob": { "docs": "The **`Blob`** object represents a blob, which is a file-like object of immutable, raw data; they can be read as text or binary data, or converted into a [ReadableStream] so its methods can be used for processing the data.\n\nBlobs can represent data that isn't necessarily in a JavaScript-native format. The [File] interface is based on `Blob`, inheriting blob functionality and expanding it to support files on the user's system.", "properties": { "arraybuffer": "The **`arrayBuffer()`** method of the [Blob]\ninterface returns a `Promise` that resolves with the contents of the blob as\nbinary data contained in an `ArrayBuffer`.", @@ -525,14 +525,14 @@ "type": "The **`type`** read-only property of the [Blob] interface returns the of the file.\n\n> **Note:** Based on the current implementation, browsers won't actually read the bytestream of a file to determine its media type.\n> It is assumed based on the file extension; a PNG image file renamed to .txt would give \"_text/plain_\" and not \"_image/png_\". Moreover, `blob.type` is generally reliable only for common file types like images, HTML documents, audio and video.\n> Uncommon file extensions would return an empty string.\n> Client configuration (for instance, the Windows Registry) may result in unexpected values even for common types. **Developers are advised not to rely on this property as a sole validation scheme.**" } }, - "blobevent": { + "BlobEvent": { "docs": "The **`BlobEvent`** interface of the [MediaStream Recording API](/en-US/docs/Web/API/MediaStream_Recording_API) represents events associated with a [Blob]. These blobs are typically, but not necessarily, associated with media content.", "properties": { "data": "The **`data`** read-only property of the [BlobEvent] interface represents a [Blob] associated with the event.", "timecode": "The **`timecode`** read-only property of the [BlobEvent] interface indicates the difference between the timestamp of the first chunk of data, and the timestamp of the first chunk in the first `BlobEvent` produced by this recorder.\n\nNote that the `timecode` in the first produced `BlobEvent` does not need to be zero." } }, - "bluetooth": { + "Bluetooth": { "docs": "The **`Bluetooth`** interface of the [Web Bluetooth API](/en-US/docs/Web/API/Web_Bluetooth_API) returns a\n`Promise` to a [BluetoothDevice] object with the specified\noptions.", "properties": { "getavailability": "The **`getAvailability()`** method of the [Bluetooth] interface returns `true` if the device has a Bluetooth adapter, and false otherwise (unless the user has configured the browser to not expose a real value).\n\n> **Note:** A user might not allow use of Web Bluetooth API, even if\n> `getAvailability()` returns `true`\n> ([Bluetooth.requestDevice] might\n> not resolve with a [BluetoothDevice]). Also, a user can configure their browser to return a fixed value instead of a real one.", @@ -540,7 +540,7 @@ "requestdevice": "The **`Bluetooth.requestDevice()`** method of the\n[Bluetooth] interface returns a `Promise` to a\n[BluetoothDevice] object with the specified options. If there is no chooser\nUI, this method returns the first device matching the criteria." } }, - "bluetoothcharacteristicproperties": { + "BluetoothCharacteristicProperties": { "docs": "The **`BluetoothCharacteristicProperties`** interface of the [Web Bluetooth API](/en-US/docs/Web/API/Web_Bluetooth_API) provides the operations that are valid on the given [BluetoothRemoteGATTCharacteristic].\n\nThis interface is returned by calling [BluetoothRemoteGATTCharacteristic.properties].", "properties": { "authenticatedsignedwrites": "The **`authenticatedSignedWrites`** read-only\nproperty of the [BluetoothCharacteristicProperties] interface returns a\n`boolean` that is `true` if signed writing to the characteristic\nvalue is permitted.", @@ -554,7 +554,7 @@ "writewithoutresponse": "The **`writeWithoutResponse`** read-only\nproperty of the [BluetoothCharacteristicProperties] interface returns a\n`boolean` that is `true` if the writing to the characteristic\nwithout response is permitted." } }, - "bluetoothdevice": { + "BluetoothDevice": { "docs": "The BluetoothDevice interface of the [Web Bluetooth API](/en-US/docs/Web/API/Web_Bluetooth_API) represents a Bluetooth device inside a particular script execution\nenvironment.", "properties": { "gatt": "The\n**`BluetoothDevice.gatt`** read-only property returns\na reference to the device's [BluetoothRemoteGATTServer].", @@ -562,7 +562,7 @@ "name": "The **`BluetoothDevice.name`** read-only property returns a\nstring that provides a human-readable name for the device." } }, - "bluetoothremotegattcharacteristic": { + "BluetoothRemoteGATTCharacteristic": { "docs": "The `BluetoothRemoteGattCharacteristic` interface of the [Web Bluetooth API](/en-US/docs/Web/API/Web_Bluetooth_API) represents a GATT Characteristic, which is a basic data element that provides further information about a peripheral's service.", "properties": { "getdescriptor": "The **`BluetoothRemoteGATTCharacteristic.getDescriptor()`** method\nreturns a `Promise` that resolves to the\nfirst [BluetoothRemoteGATTDescriptor] for a given descriptor UUID.", @@ -579,7 +579,7 @@ "writevaluewithresponse": "The **`BluetoothRemoteGATTCharacteristic.writeValueWithResponse()`** method sets a [BluetoothRemoteGATTCharacteristic] object's `value` property to the bytes contained in a given `ArrayBuffer`, calls [`WriteCharacteristicValue`(_this_=`this`, _value=value_, _response_=`\"required\"`)](https://webbluetoothcg.github.io/web-bluetooth/#writecharacteristicvalue), and returns the resulting `Promise`." } }, - "bluetoothremotegattdescriptor": { + "BluetoothRemoteGATTDescriptor": { "docs": "The `BluetoothRemoteGATTDescriptor` interface of the [Web Bluetooth API](/en-US/docs/Web/API/Web_Bluetooth_API) provides a GATT Descriptor,\nwhich provides further information about a characteristic's value.", "properties": { "characteristic": "The **`BluetoothRemoteGATTDescriptor.characteristic`**\nread-only property returns the [BluetoothRemoteGATTCharacteristic] this\ndescriptor belongs to.", @@ -589,7 +589,7 @@ "writevalue": "The **`BluetoothRemoteGATTDescriptor.writeValue()`**\nmethod sets the value property to the bytes contained in\nan `ArrayBuffer` and returns a `Promise`." } }, - "bluetoothremotegattserver": { + "BluetoothRemoteGATTServer": { "docs": "The **`BluetoothRemoteGATTServer`** interface of the [Web Bluetooth API](/en-US/docs/Web/API/Web_Bluetooth_API) represents a GATT\nServer on a remote device.", "properties": { "connect": "The\n**`BluetoothRemoteGATTServer.connect()`** method causes the\nscript execution environment to connect to `this.device`.", @@ -600,7 +600,7 @@ "getprimaryservices": "The **BluetoothRemoteGATTServer.getPrimaryServices()** method returns a\npromise to a list of primary [BluetoothRemoteGATTService] objects offered by the\nBluetooth device for a specified `BluetoothServiceUUID`." } }, - "bluetoothremotegattservice": { + "BluetoothRemoteGATTService": { "docs": "The `BluetoothRemoteGATTService` interface of the [Web Bluetooth API](/en-US/docs/Web/API/Web_Bluetooth_API) represents a\nservice provided by a GATT server, including a device, a list of referenced services,\nand a list of the characteristics of this service.", "properties": { "device": "The **`BluetoothGATTService.device`** read-only property\nreturns information about a Bluetooth device through an instance of\n[BluetoothDevice].", @@ -610,7 +610,7 @@ "uuid": "The **`BluetoothGATTService.uuid`** read-only property\nreturns a string representing the UUID of this service." } }, - "bluetoothuuid": { + "BluetoothUUID": { "docs": "The **`BluetoothUUID`** interface of the [Web Bluetooth API] provides a way to look up Universally Unique Identifier (UUID) values by name in the\n[registry](https://www.bluetooth.com/specifications/assigned-numbers/) maintained by the Bluetooth SIG.", "properties": { "canonicaluuid_static": "The **`canonicalUUID()`** static method of the [BluetoothUUID] interface returns the 128-bit UUID when passed a 16- or 32-bit UUID alias.", @@ -619,7 +619,7 @@ "getservice_static": "The **`getService()`** static method of the [BluetoothUUID] interface returns a UUID representing a registered service when passed a name or the 16- or 32-bit UUID alias." } }, - "broadcastchannel": { + "BroadcastChannel": { "docs": "The **`BroadcastChannel`** interface represents a named channel that any of a given can subscribe to. It allows communication between different documents (in different windows, tabs, frames or iframes) of the same origin. Messages are broadcasted via a [BroadcastChannel/message_event] event fired at all `BroadcastChannel` objects listening to the channel, except the object that sent the message.", "properties": { "close": "The **`BroadcastChannel.close()`** terminates the connection to\nthe underlying channel, allowing the object to be garbage collected.\nThis is a necessary step to perform\nas there is no other way for a browser to know\nthat this channel is not needed anymore.", @@ -629,840 +629,813 @@ "postmessage": "The **`BroadcastChannel.postMessage()`** sends a message,\nwhich can be of any kind of `Object`,\nto each listener in any with the same .\nThe message is transmitted as a ['message'](/en-US/docs/Web/API/BroadcastChannel/message_event) event\ntargeted at each [BroadcastChannel] bound to the channel." } }, - "bytelengthqueuingstrategy": { + "ByteLengthQueuingStrategy": { "docs": "The **`ByteLengthQueuingStrategy`** interface of the [Streams API](/en-US/docs/Web/API/Streams_API) provides a built-in byte length queuing strategy that can be used when constructing streams.", "properties": { "highwatermark": "The read-only **`ByteLengthQueuingStrategy.highWaterMark`** property returns the total number of bytes that can be contained in the internal queue before [backpressure](/en-US/docs/Web/API/Streams_API/Concepts#backpressure) is applied.\n\n> **Note:** Unlike [`CountQueuingStrategy()`](/en-US/docs/Web/API/CountQueuingStrategy/CountQueuingStrategy) where the `highWaterMark` property specifies a simple count of the number of chunks, with `ByteLengthQueuingStrategy()`, the `highWaterMark` parameter specifies a number of _bytes_ — specifically, given a stream of chunks, how many bytes worth of those chunks (rather than a count of how many of those chunks) can be contained in the internal queue before backpressure is applied.", "size": "The **`size()`** method of the\n[ByteLengthQueuingStrategy] interface returns the given chunk's\n`byteLength` property." } }, - "cache": { - "docs": "The **`Cache`** interface provides a persistent storage mechanism for [Request] / [Response] object pairs that are cached in long lived memory. How long a `Cache` object lives is browser dependent, but a single origin's scripts can typically rely on the presence of a previously populated `Cache` object. Note that the `Cache` interface is exposed to windowed scopes as well as workers. You don't have to use it in conjunction with service workers, even though it is defined in the service worker spec.\n\nAn origin can have multiple, named `Cache` objects. You are responsible for implementing how your script (e.g. in a [ServiceWorker]) handles `Cache` updates. Items in a `Cache` do not get updated unless explicitly requested; they don't expire unless deleted. Use [CacheStorage.open] to open a specific named `Cache` object and then call any of the `Cache` methods to maintain the `Cache`.\n\nYou are also responsible for periodically purging cache entries. Each browser has a hard limit on the amount of cache storage that a given origin can use. `Cache` quota usage estimates are available via the [StorageManager.estimate] method. The browser does its best to manage disk space, but it may delete the `Cache` storage for an origin. The browser will generally delete all of the data for an origin or none of the data for an origin. Make sure to version caches by name and use the caches only from the version of the script that they can safely operate on. See [Deleting old caches](/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers#deleting_old_caches) for more information.\n\n> **Note:** The key matching algorithm depends on the [VARY header](https://www.fastly.com/blog/best-practices-using-vary-header) in the value. So matching a new key requires looking at both key and value for entries in the `Cache` object.\n\n> **Note:** The caching API doesn't honor HTTP caching headers.", + "CDATASection": { + "docs": "The **`CDATASection`** interface represents a CDATA section\nthat can be used within XML to include extended portions of unescaped text.\nWhen inside a CDATA section, the symbols `<` and `&` don't need escaping\nas they normally do.\n\nIn XML, a CDATA section looks like:\n\n```xml\n\n```\n\nFor example:\n\n```html\n\n Here is a CDATA section: & ]]> with all kinds of unescaped text.\n\n```\n\nThe only sequence which is not allowed within a CDATA section is the closing sequence\nof a CDATA section itself, `]]>`.\n\n> **Note:** CDATA sections should not be used within HTML they are considered as comments and not displayed." + }, + "CSPViolationReportBody": { + "docs": "The `CSPViolationReportBody` interface contains the report data for a Content Security Policy (CSP) violation. CSP violations are thrown when the webpage attempts to load a resource that violates the CSP set by the HTTP header.\n\n> **Note:** this interface is similar, but not identical to, the [JSON objects](/en-US/docs/Web/HTTP/CSP#violation_report_syntax) sent back to the [`report-uri`](/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-uri) or [`report-to`](/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-to) policy directive of the header." + }, + "CSS": { + "docs": "The **`CSS`** interface holds useful CSS-related methods. No objects with this interface are implemented: it contains only static methods and is therefore a utilitarian interface.", "properties": { - "add": "The **`add()`** method of the [Cache] interface takes a URL, retrieves it, and adds the resulting response object to the given cache.\n\nThe `add()` method is functionally equivalent to the following:\n\n```js\nfetch(url).then((response) => {\n if (!response.ok) {\n throw new TypeError(\"bad response status\");\n }\n return cache.put(url, response);\n});\n```\n\nFor more complex operations, you'll need to use [Cache.put] directly.\n\n> **Note:** `add()` will overwrite any key/value pair previously stored in the cache that matches the request.", - "addall": "The **`addAll()`** method of the [Cache] interface takes an array of URLs, retrieves them, and adds the resulting response objects to the given cache. The request objects created during retrieval become keys to the stored response operations.\n\n> **Note:** `addAll()` will overwrite any key/value pairs\n> previously stored in the cache that match the request, but will fail if a\n> resulting `put()` operation would overwrite a previous cache entry stored by the same `addAll()` method.", - "delete": "The **`delete()`** method of the [Cache] interface finds the [Cache] entry whose key is the request, and if found, deletes the [Cache] entry and returns a `Promise` that resolves to `true`.\nIf no [Cache] entry is found, it resolves to `false`.", - "keys": "The **`keys()`** method of the [Cache] interface returns a\n`Promise` that resolves to an array of [Request] objects\nrepresenting the keys of the [Cache].\n\nThe requests are returned in the same order that they were inserted.\n\n> **Note:** Requests with duplicate URLs but different headers can be\n> returned if their responses have the `VARY` header set on them.", - "match": "The **`match()`** method of the [Cache] interface returns a `Promise` that resolves to the [Response] associated with the first matching request in the [Cache] object.\nIf no match is found, the `Promise` resolves to `undefined`.", - "matchall": "The **`matchAll()`** method of the [Cache]\ninterface returns a `Promise` that resolves to an array of all matching\nresponses in the [Cache] object.", - "put": "The **`put()`** method of the\n[Cache] interface allows key/value pairs to be added to the current\n[Cache] object.\n\nOften, you will just want to [fetch]\none or more requests, then add the result straight to your cache. In such cases you are\nbetter off using\n[Cache.add]/[Cache.addAll], as\nthey are shorthand functions for one or more of these operations.\n\n```js\nfetch(url).then((response) => {\n if (!response.ok) {\n throw new TypeError(\"Bad response status\");\n }\n return cache.put(url, response);\n});\n```\n\n> **Note:** `put()` will overwrite any key/value pair\n> previously stored in the cache that matches the request.\n\n> **Note:** [Cache.add]/[Cache.addAll] do not\n> cache responses with `Response.status` values that are not in the 200\n> range, whereas [Cache.put] lets you store any request/response pair. As a\n> result, [Cache.add]/[Cache.addAll] can't be used to store\n> opaque responses, whereas [Cache.put] can." + "escape_static": "The **`CSS.escape()`** static method returns a\nstring containing the escaped string passed as parameter, mostly for\nuse as part of a CSS selector.", + "factory_functions_static": "The **CSS numeric factory\nfunctions**, such as `CSS.em()` and\n`CSS.turn()` are methods that return [CSSUnitValues](/en-US/docs/Web/API/CSSUnitValue) with the value being\nthe numeric argument and the unit being the name of the method used. These\nfunctions create new numeric values less verbosely than using the\n[CSSUnitValue.CSSUnitValue] constructor.", + "highlights_static": "The static, read-only **`highlights`** property of the [CSS] interface provides access to the `HighlightRegistry` used to style arbitrary text ranges using the [css_custom_highlight_api].", + "paintworklet_static": "The static, read-only **`paintWorklet`** property of the [CSS] interface provides access to the\npaint [worklet](/en-US/docs/Web/API/Worklet), which programmatically generates an image where a CSS\nproperty expects a file.", + "registerproperty_static": "The **`CSS.registerProperty()`** static method registers\n, allowing for property type checking, default\nvalues, and properties that do or do not inherit their value.\n\nRegistering a custom property allows you to tell the browser how the custom property\nshould behave; what types are allowed, whether the custom property inherits its value,\nand what the default value of the custom property is.", + "supports_static": "The **`CSS.supports()`** static method returns a boolean value\nindicating if the browser supports a given CSS feature, or not." } }, - "cachestorage": { - "docs": "The **`CacheStorage`** interface represents the storage for [Cache] objects.\n\nThe interface:\n\n- Provides a master directory of all the named caches that can be accessed by a [ServiceWorker] or other type of worker or [window] scope (you're not limited to only using it with service workers).\n- Maintains a mapping of string names to corresponding [Cache] objects.\n\nUse [CacheStorage.open] to obtain a [Cache] instance.\n\nUse [CacheStorage.match] to check if a given [Request] is a key in any of the [Cache] objects that the `CacheStorage` object tracks.\n\nYou can access `CacheStorage` through the global [caches] property.\n\n> **Note:** `CacheStorage` always rejects with a `SecurityError` on untrusted origins (i.e. those that aren't using HTTPS, although this definition will likely become more complex in the future.) When testing on Firefox, you can get around this by checking the **Enable Service Workers over HTTP (when toolbox is open)** option in the Firefox Devtools options/gear menu. Furthermore, because `CacheStorage` requires file-system access, it may be unavailable in private mode in Firefox.\n\n> **Note:** [CacheStorage.match] is a convenience method. Equivalent functionality to match a cache entry can be implemented by returning an array of cache names from [CacheStorage.keys], opening each cache with [CacheStorage.open], and matching the one you want with [Cache.match].", + "CSSAnimation": { + "docs": "The **`CSSAnimation`** interface of the [Web Animations API] represents an [Animation] object.", "properties": { - "delete": "The **`delete()`** method of the [CacheStorage] interface finds the [Cache] object matching the `cacheName`, and if found, deletes the [Cache] object and returns a `Promise` that resolves to `true`.\nIf no [Cache] object is found, it resolves to `false`.\n\nYou can access `CacheStorage` through the global [caches] property.", - "has": "The **`has()`** method of the [CacheStorage]\ninterface returns a `Promise` that resolves to `true` if a\n[Cache] object matches the `cacheName`.\n\nYou can access `CacheStorage` through the global [caches] property.", - "keys": "The **`keys()`** method of the [CacheStorage] interface returns a `Promise` that will resolve with an array containing strings corresponding to all of the named [Cache] objects tracked by the [CacheStorage] object in the order they were created.\nUse this method to iterate over a list of all [Cache] objects.\n\nYou can access `CacheStorage` through the global [caches] property.", - "match": "The **`match()`** method of the [CacheStorage] interface checks if a given [Request] or URL string is a key for a stored [Response].\nThis method returns a `Promise` for a [Response], or a `Promise` which resolves to `undefined` if no match is found.\n\nYou can access `CacheStorage` through the global\n[caches] property.\n\n`Cache` objects are searched in creation order.\n\n> **Note:** [CacheStorage.match] is a convenience method.\n> Equivalent functionality is to call [cache.match] on each cache (in the order returned by [CacheStorage.keys]) until a [Response] is returned.", - "open": "The **`open()`** method of the\n[CacheStorage] interface returns a `Promise` that resolves to\nthe [Cache] object matching the `cacheName`.\n\nYou can access `CacheStorage` through the global\n[caches] property.\n\n> **Note:** If the specified [Cache] does not exist, a new\n> cache is created with that `cacheName` and a `Promise` that\n> resolves to this new [Cache] object is returned." + "animationname": "The **`animationName`** property of the\n[CSSAnimation] interface returns the . This\nspecifies one or more keyframe at-rules which describe the animation applied to the\nelement." } }, - "canmakepaymentevent": { - "docs": "The **`CanMakePaymentEvent`** interface of the [Payment Handler API] is the event object for the [ServiceWorkerGlobalScope.canmakepayment_event] event, fired on a payment app's service worker to check whether it is ready to handle a payment. Specifically, it is fired when the merchant website calls [PaymentRequest.PaymentRequest].", + "CSSConditionRule": { + "docs": "An object implementing the **`CSSConditionRule`** interface represents a single condition CSS [at-rule](/en-US/docs/Web/CSS/At-rule), which consists of a condition and a statement block.\n\nThree objects derive from `CSSConditionRule`: [CSSMediaRule], [CSSContainerRule] and [CSSSupportsRule].", "properties": { - "respondwith": "The **`respondWith()`** method of the [CanMakePaymentEvent] interface enables the service worker to respond appropriately to signal whether it is ready to handle payments." + "conditiontext": "The **`conditionText`** property of\nthe [CSSConditionRule] interface returns or sets the text of the CSS\nrule." } }, - "canvascapturemediastreamtrack": { - "docs": "The **`CanvasCaptureMediaStreamTrack`** interface of the [Media Capture and Streams API] represents the video track contained in a [MediaStream] being generated from a `canvas` following a call to [HTMLCanvasElement.captureStream].", + "CSSContainerRule": { + "docs": "The **`CSSContainerRule`** interface represents a single CSS rule.\n\nAn object of this type can be used to get the query conditions for the , along with the container name if one is defined.\nNote that the container name and query together define the \"condition text\", which can be obtained using [CSSConditionRule.conditionText].", "properties": { - "canvas": "The **`canvas`** read-only property of the [CanvasCaptureMediaStreamTrack] interface returns the [HTMLCanvasElement] from which frames are being captured.", - "requestframe": "The **`requestFrame()`** method of the [CanvasCaptureMediaStreamTrack] interface requests that a frame be captured from the canvas and sent to the stream.\n\nApplications that need to carefully control\nthe timing of rendering and frame capture can use `requestFrame()` to\ndirectly specify when it's time to capture a frame.\n\nTo prevent automatic capture of frames, so that frames are only captured when\n`requestFrame()` is called, specify a value of 0 for the\n[HTMLCanvasElement.captureStream] method when creating\nthe stream." + "containername": "The read-only **`containerName`** property of the [CSSContainerRule] interface represents the container name of the associated CSS at-rule.\n\nFor example, the value of `containerName` for the below is `sidebar`:\n\n```css\n@container sidebar (min-width: 700px) {\n .card {\n font-size: 2em;\n }\n}\n```", + "containerquery": "The read-only **`containerQuery`** property of the [CSSContainerRule] interface returns a string representing the container conditions that are evaluated when the container changes size in order to determine if the styles in the associated are applied.\n\nFor example, the value of `containerQuery` for the below is `(min-width: 700px)`:\n\n```css\n@container sidebar (min-width: 700px) {\n .card {\n font-size: 2em;\n }\n}\n```" } }, - "canvasgradient": { - "docs": "The **`CanvasGradient`** interface represents an [opaque object](https://en.wikipedia.org/wiki/Opaque_data_type) describing a gradient. It is returned by the methods [CanvasRenderingContext2D.createLinearGradient], [CanvasRenderingContext2D.createConicGradient] or [CanvasRenderingContext2D.createRadialGradient].\n\nIt can be used as a [CanvasRenderingContext2D.fillStyle] or [CanvasRenderingContext2D.strokeStyle].", + "CSSCounterStyleRule": { + "docs": "The **`CSSCounterStyleRule`** interface represents an [at-rule](/en-US/docs/Web/CSS/At-rule).", "properties": { - "addcolorstop": "The **`CanvasGradient.addColorStop()`** method adds a new color stop,\ndefined by an `offset` and a `color`, to a given canvas gradient." + "additivesymbols": "The **`additiveSymbols`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "fallback": "The **`fallback`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "name": "The **`name`** property of the [CSSCounterStyleRule] interface gets and sets the defined as the `name` for the associated rule.", + "negative": "The **`negative`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "pad": "The **`pad`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "prefix": "The **`prefix`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "range": "The **`range`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "speakas": "The **`speakAs`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "suffix": "The **`suffix`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "symbols": "The **`symbols`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string.", + "system": "The **`system`** property of the [CSSCounterStyleRule] interface gets and sets the value of the descriptor. If the descriptor does not have a value set, this attribute returns an empty string." } }, - "canvaspattern": { - "docs": "The **`CanvasPattern`** interface represents an [opaque object](https://en.wikipedia.org/wiki/Opaque_data_type) describing a pattern, based on an image, a canvas, or a video, created by the [CanvasRenderingContext2D.createPattern] method.\n\nIt can be used as a [CanvasRenderingContext2D.fillStyle] or [CanvasRenderingContext2D.strokeStyle].", + "CSSFontFaceRule": { + "docs": "The **`CSSFontFaceRule`** interface represents an [at-rule](/en-US/docs/Web/CSS/At-rule).", "properties": { - "settransform": "The **`CanvasPattern.setTransform()`** method uses a [DOMMatrix] object as the pattern's transformation matrix and invokes it on the pattern." + "style": "The read-only **`style`** property of the [CSSFontFaceRule] interface returns the style information from the [at-rule](/en-US/docs/Web/CSS/At-rule). This will be in the form of a [CSSStyleDeclaration] object." } }, - "canvasrenderingcontext2d": { - "docs": "The **`CanvasRenderingContext2D`** interface, part of the [Canvas API](/en-US/docs/Web/API/Canvas_API), provides the 2D rendering context for the drawing surface of a `canvas` element.\nIt is used for drawing shapes, text, images, and other objects.\n\nThe interface's properties and methods are described in the reference section of this page.\nThe [Canvas tutorial](/en-US/docs/Web/API/Canvas_API/Tutorial) has more explanation, examples, and resources, as well.\n\nFor [`OffscreenCanvas`](/en-US/docs/Web/API/OffscreenCanvas), there is an equivalent interface that provides the rendering context.\nThe offscreen rendering context inherits most of the same properties and methods as the `CanvasRenderingContext2D` and is described in more detail in the [OffscreenCanvasRenderingContext2D] reference page.", + "CSSFontFeatureValuesRule": { + "docs": "The **`CSSFontFeatureValuesRule`** interface represents an [at-rule](/en-US/docs/Web/CSS/At-rule), letting developers assign for each font face a common name to specify features indices to be used in .", "properties": { - "arc": "The\n**`CanvasRenderingContext2D.arc()`**\nmethod of the [Canvas 2D API](/en-US/docs/Web/API/CanvasRenderingContext2D) adds a circular arc to the current sub-path.", - "arcto": "The **`CanvasRenderingContext2D.arcTo()`** method of the Canvas 2D API adds a circular arc to the current sub-path, using the given control points and radius.\nThe arc is automatically connected to the path's latest point with a straight line if necessary, for example if the starting point and control points are in a line.\n\nThis method is commonly used for making rounded corners.\n\n> **Note:** You may get unexpected results when using a\n> relatively large radius: the arc's connecting line will go in whatever direction it\n> must to meet the specified radius.", - "beginpath": "The\n**`CanvasRenderingContext2D.beginPath()`**\nmethod of the Canvas 2D API starts a new path by emptying the list of sub-paths. Call\nthis method when you want to create a new path.\n\n> **Note:** To create a new sub-path, i.e., one matching the current\n> canvas state, you can use [CanvasRenderingContext2D.moveTo].", - "beziercurveto": "The\n**`CanvasRenderingContext2D.bezierCurveTo()`**\nmethod of the Canvas 2D API adds a cubic [Bézier curve](/en-US/docs/Glossary/Bezier_curve) to the current\nsub-path. It requires three points: the first two are control points and the third one\nis the end point. The starting point is the latest point in the current path, which can\nbe changed using [CanvasRenderingContext2D.moveTo] before\ncreating the Bézier curve.", - "canvas": "The **`CanvasRenderingContext2D.canvas`** property, part of the\n[Canvas API](/en-US/docs/Web/API/Canvas_API), is a read-only reference to the\n[HTMLCanvasElement] object that is associated with a given context. It\nmight be [`null`](/en-US/docs/Web/JavaScript/Reference/Operators/null) if there is no associated `canvas` element.", - "clearrect": "The\n**`CanvasRenderingContext2D.clearRect()`**\nmethod of the Canvas 2D API erases the pixels in a rectangular area by setting them to\ntransparent black.\n\n> **Note:** Be aware that `clearRect()` may cause unintended\n> side effects if you're not [using paths properly](/en-US/docs/Web/API/Canvas_API/Tutorial/Drawing_shapes#drawing_paths). Make sure to call\n> [CanvasRenderingContext2D.beginPath] before starting to\n> draw new items after calling `clearRect()`.", - "clip": "The\n**`CanvasRenderingContext2D.clip()`**\nmethod of the Canvas 2D API turns the current or given path into the current clipping\nregion. The previous clipping region, if any, is intersected with the current or given\npath to create the new clipping region.\n\nIn the image below, the red outline represents a clipping region shaped like a star.\nOnly those parts of the checkerboard pattern that are within the clipping region get\ndrawn.\n\n![Star-shaped clipping region](canvas_clipping_path.png)\n\n> **Note:** Be aware that the clipping region is only constructed from\n> shapes added to the path. It doesn't work with shape primitives drawn directly to the\n> canvas, such as [CanvasRenderingContext2D.fillRect].\n> Instead, you'd have to use [CanvasRenderingContext2D.rect] to\n> add a rectangular shape to the path before calling `clip()`.\n\n> **Note:** Clip paths cannot be reverted directly. You must save your canvas state using [CanvasRenderingContext2D/save] before calling `clip()`, and restore it once you have finished drawing in the clipped area using [CanvasRenderingContext2D/restore].", - "closepath": "The\n**`CanvasRenderingContext2D.closePath()`**\nmethod of the Canvas 2D API attempts to add a straight line from the current point to\nthe start of the current sub-path. If the shape has already been closed or has only one\npoint, this function does nothing.\n\nThis method doesn't draw anything to the canvas directly. You can render the path using\nthe [CanvasRenderingContext2D.stroke] or\n[CanvasRenderingContext2D.fill] methods.", - "createconicgradient": "The **`CanvasRenderingContext2D.createConicGradient()`** method of the Canvas 2D API creates a gradient around a point with given coordinates.\n\nThis method returns a conic [CanvasGradient]. To be applied to a shape, the gradient must first be assigned to the [CanvasRenderingContext2D.fillStyle] or [CanvasRenderingContext2D.strokeStyle] properties.\n\n> **Note:** Gradient coordinates are global, i.e., relative to the current coordinate space. When applied to a shape, the coordinates are NOT relative to the shape's coordinates.", - "createimagedata": "The **`CanvasRenderingContext2D.createImageData()`** method of\nthe Canvas 2D API creates a new, blank [ImageData] object with the\nspecified dimensions. All of the pixels in the new object are transparent black.", - "createlineargradient": "The\n**`CanvasRenderingContext2D.createLinearGradient()`**\nmethod of the Canvas 2D API creates a gradient along the line connecting two given\ncoordinates.\n\n![The gradient transitions colors along the gradient line, starting at point x0, y0 and going to x1, y1, even if those points extend the gradient line beyond the edges of the element on which the gradient is drawn.](mdn-canvas-lineargradient.png)\n\nThis method returns a linear [CanvasGradient]. To be applied to a shape,\nthe gradient must first be assigned to the\n[CanvasRenderingContext2D.fillStyle] or\n[CanvasRenderingContext2D.strokeStyle] properties.\n\n> **Note:** Gradient coordinates are global, i.e., relative to the current\n> coordinate space. When applied to a shape, the coordinates are NOT relative to the\n> shape's coordinates.", - "createpattern": "The **`CanvasRenderingContext2D.createPattern()`** method of the Canvas 2D API creates a pattern using the specified image and repetition.\nThis method returns a [CanvasPattern].\n\nThis method doesn't draw anything to the canvas directly.\nThe pattern it creates must be assigned to the [CanvasRenderingContext2D.fillStyle] or [CanvasRenderingContext2D.strokeStyle] properties, after which it is applied to any subsequent drawing.", - "createradialgradient": "The\n**`CanvasRenderingContext2D.createRadialGradient()`**\nmethod of the Canvas 2D API creates a radial gradient using the size and coordinates of\ntwo circles.\n\nThis method returns a [CanvasGradient]. To be applied to a shape, the\ngradient must first be assigned to the [CanvasRenderingContext2D.fillStyle] or [CanvasRenderingContext2D.strokeStyle]\nproperties.\n\n> **Note:** Gradient coordinates are global, i.e., relative to the current\n> coordinate space. When applied to a shape, the coordinates are NOT relative to the\n> shape's coordinates.", - "direction": "The\n**`CanvasRenderingContext2D.direction`**\nproperty of the Canvas 2D API specifies the current text direction used to draw text.", - "drawfocusifneeded": "The\n**`CanvasRenderingContext2D.drawFocusIfNeeded()`**\nmethod of the Canvas 2D API draws a focus ring around the current or given path, if the\nspecified element is focused.", - "drawimage": "The **`CanvasRenderingContext2D.drawImage()`** method of the\nCanvas 2D API provides different ways to draw an image onto the canvas.", - "ellipse": "The\n**`CanvasRenderingContext2D.ellipse()`**\nmethod of the Canvas 2D API adds an elliptical arc to the current sub-path.", - "fill": "The\n**`CanvasRenderingContext2D.fill()`**\nmethod of the Canvas 2D API fills the current or given path with the current\n[CanvasRenderingContext2D.fillStyle].", - "fillrect": "The\n**`CanvasRenderingContext2D.fillRect()`**\nmethod of the Canvas 2D API draws a rectangle that is filled according to the current\n[CanvasRenderingContext2D.fillStyle].\n\nThis method draws directly to the canvas without modifying the current path, so any\nsubsequent [CanvasRenderingContext2D.fill] or\n[CanvasRenderingContext2D.stroke] calls will have no effect\non it.", - "fillstyle": "The\n**`CanvasRenderingContext2D.fillStyle`**\nproperty of the [Canvas 2D API](/en-US/docs/Web/API/Canvas_API) specifies the\ncolor, gradient, or pattern to use inside shapes. The default style is `#000`\n(black).\n\n> **Note:** For more examples of fill and stroke styles, see [Applying styles and color](/en-US/docs/Web/API/Canvas_API/Tutorial/Applying_styles_and_colors) in the [Canvas tutorial](/en-US/docs/Web/API/Canvas_API/Tutorial).", - "filltext": "The [CanvasRenderingContext2D] method\n**`fillText()`**, part of the Canvas 2D API, draws a text string\nat the specified coordinates, filling the string's characters with the current\n[CanvasRenderingContext2D.fillStyle]. An optional parameter\nallows specifying a maximum width for the rendered text, which the will achieve by condensing the text or by using a lower font size.\n\nThis method draws directly to the canvas without modifying the current path, so any\nsubsequent [CanvasRenderingContext2D.fill] or\n[CanvasRenderingContext2D.stroke] calls will have no effect\non it.\n\nThe text is rendered using the font and text layout configuration as defined by the\n[CanvasRenderingContext2D.font],\n[CanvasRenderingContext2D.textAlign],\n[CanvasRenderingContext2D.textBaseline], and\n[CanvasRenderingContext2D.direction] properties.\n\n> **Note:** To draw the outlines of the characters in a string, call the context's\n> [CanvasRenderingContext2D.strokeText] method.", - "filter": "The\n**`CanvasRenderingContext2D.filter`**\nproperty of the Canvas 2D API provides filter effects such as blurring and grayscaling.\nIt is similar to the CSS `filter` property and accepts the same values.", - "font": "The **`CanvasRenderingContext2D.font`** property of the Canvas 2D API specifies the current text style to use when drawing text.\nThis string uses the same syntax as the [CSS font](/en-US/docs/Web/CSS/font) specifier.", - "fontkerning": "The **`CanvasRenderingContext2D.fontKerning`** property of the [Canvas API](/en-US/docs/Web/API/Canvas_API) specifies how font kerning information is used.\n\nKerning adjusts how adjacent letters are spaced in a proportional font, allowing them to edge into each other's visual area if there is space available.\nFor example, in well-kerned fonts, the characters `AV`, `Ta` and `We` nest together and make character spacing more uniform and pleasant to read than the equivalent text without kerning.\n\nThe property corresponds to the [`font-kerning`](/en-US/docs/Web/CSS/font-kerning) CSS property.", - "fontstretch": "The **`CanvasRenderingContext2D.fontStretch`** property of the [Canvas API](/en-US/docs/Web/API/Canvas_API) specifies how the font may be expanded or condensed when drawing text.\n\nThe property corresponds to the [`font-stretch`](/en-US/docs/Web/CSS/font-stretch) CSS property when used with keywords (percentage values are not supported).", - "fontvariantcaps": "The **`CanvasRenderingContext2D.fontVariantCaps`** property of the [Canvas API](/en-US/docs/Web/API/Canvas_API) specifies an alternative capitalization of the rendered text.\n\nThis corresponds to the CSS [`font-variant-caps`](/en-US/docs/Web/CSS/font-variant-caps) property.", - "getcontextattributes": "The **`CanvasRenderingContext2D.getContextAttributes()`** method returns an object that contains attributes used by the context.\n\nNote that context attributes may be requested when creating the context with [`HTMLCanvasElement.getContext()`](/en-US/docs/Web/API/HTMLCanvasElement/getContext), but the attributes that are actually supported and used may differ.", - "getimagedata": "The [CanvasRenderingContext2D] method\n**`getImageData()`** of the Canvas 2D API returns an\n[ImageData] object representing the underlying pixel data for a specified\nportion of the canvas.\n\nThis method is not affected by the canvas's transformation matrix. If the specified\nrectangle extends outside the bounds of the canvas, the pixels outside the canvas are\ntransparent black in the returned `ImageData` object.\n\n> **Note:** Image data can be painted onto a canvas using the\n> [CanvasRenderingContext2D.putImageData] method.\n\nYou can find more information about `getImageData()` and general\nmanipulation of canvas contents in [Pixel manipulation with canvas](/en-US/docs/Web/API/Canvas_API/Tutorial/Pixel_manipulation_with_canvas).", - "getlinedash": "The **`getLineDash()`** method of the Canvas 2D API's\n[CanvasRenderingContext2D] interface gets the current line dash pattern.", - "gettransform": "The **`CanvasRenderingContext2D.getTransform()`** method of the Canvas 2D API retrieves the current transformation matrix being applied to the context.", - "globalalpha": "The\n**`CanvasRenderingContext2D.globalAlpha`**\nproperty of the Canvas 2D API specifies the alpha (transparency) value that is applied\nto shapes and images before they are drawn onto the canvas.\n\n> **Note:** See also the chapter [Applying styles and color](/en-US/docs/Web/API/Canvas_API/Tutorial/Applying_styles_and_colors) in the [Canvas Tutorial](/en-US/docs/Web/API/Canvas_API/Tutorial).", - "globalcompositeoperation": "The\n**`CanvasRenderingContext2D.globalCompositeOperation`**\nproperty of the Canvas 2D API sets the type of compositing operation to apply when\ndrawing new shapes.\n\nSee also [Compositing and clipping](/en-US/docs/Web/API/Canvas_API/Tutorial/Compositing) in the [Canvas Tutorial](/en-US/docs/Web/API/Canvas_API/Tutorial).", - "imagesmoothingenabled": "The **`imageSmoothingEnabled`** property of the\n[CanvasRenderingContext2D] interface, part of the [Canvas API](/en-US/docs/Web/API/Canvas_API), determines whether scaled images\nare smoothed (`true`, default) or not (`false`). On getting the\n`imageSmoothingEnabled` property, the last value it was set to is returned.\n\nThis property is useful for games and other apps that use pixel art. When enlarging\nimages, the default resizing algorithm will blur the pixels. Set this property to\n`false` to retain the pixels' sharpness.\n\n> **Note:** You can adjust the smoothing quality with the\n> [CanvasRenderingContext2D.imageSmoothingQuality]\n> property.", - "imagesmoothingquality": "The **`imageSmoothingQuality`** property of the\n[CanvasRenderingContext2D] interface, part of the [Canvas API](/en-US/docs/Web/API/Canvas_API), lets you set the quality of\nimage smoothing.\n\n> **Note:** For this property to have an effect,\n> [CanvasRenderingContext2D.imageSmoothingEnabled]\n> must be `true`.", - "iscontextlost": "The **`CanvasRenderingContext2D.isContextLost()`** method of the Canvas 2D API returns `true` if the rendering context is lost (and has not yet been reset).\nThis might occur due to driver crashes, running out of memory, and so on.\n\nIf the user agent detects that the canvas backing storage is lost it will fire the [`contextlost` event](/en-US/docs/Web/API/HTMLCanvasElement/contextlost_event) at the associated [`HTMLCanvasElement`](/en-US/docs/Web/API/HTMLCanvasElement).\nIf this event is not cancelled it will attempt to reset the backing storage to the default state (this is equivalent to calling [CanvasRenderingContext2D.reset]).\nOn success it will fire the [`contextrestored` event](/en-US/docs/Web/API/HTMLCanvasElement/contextrestored_event), indicating that the context is ready to reinitialize and redraw.", - "ispointinpath": "The\n**`CanvasRenderingContext2D.isPointInPath()`**\nmethod of the Canvas 2D API reports whether or not the specified point is contained in\nthe current path.", - "ispointinstroke": "The\n**`CanvasRenderingContext2D.isPointInStroke()`**\nmethod of the Canvas 2D API reports whether or not the specified point is inside the\narea contained by the stroking of a path.", - "letterspacing": "The **`CanvasRenderingContext2D.letterSpacing`** property of the [Canvas API](/en-US/docs/Web/API/Canvas_API) specifies the spacing between letters when drawing text.\n\nThis corresponds to the CSS [`letter-spacing`](/en-US/docs/Web/CSS/letter-spacing) property.", - "linecap": "The\n**`CanvasRenderingContext2D.lineCap`**\nproperty of the Canvas 2D API determines the shape used to draw the end points of lines.\n\n> **Note:** Lines can be drawn with the\n> [CanvasRenderingContext2D.stroke], [CanvasRenderingContext2D.strokeRect],\n> and [CanvasRenderingContext2D.strokeText] methods.", - "linedashoffset": "The\n**`CanvasRenderingContext2D.lineDashOffset`**\nproperty of the Canvas 2D API sets the line dash offset, or \"phase.\"\n\n> **Note:** Lines are drawn by calling the\n> [CanvasRenderingContext2D.stroke] method.", - "linejoin": "The\n**`CanvasRenderingContext2D.lineJoin`**\nproperty of the Canvas 2D API determines the shape used to join two line segments where\nthey meet.\n\nThis property has no effect wherever two connected segments have the same direction,\nbecause no joining area will be added in this case. Degenerate segments with a length of\nzero (i.e., with all endpoints and control points at the exact same position) are also\nignored.\n\n> **Note:** Lines can be drawn with the\n> [CanvasRenderingContext2D.stroke],\n> [CanvasRenderingContext2D.strokeRect],\n> and [CanvasRenderingContext2D.strokeText] methods.", - "lineto": "The [CanvasRenderingContext2D] method\n**`lineTo()`**, part of the Canvas 2D API, adds a straight line\nto the current sub-path by connecting the sub-path's last point to the specified\n`(x, y)` coordinates.\n\nLike other methods that modify the current path, this method does not directly render\nanything. To draw the path onto a canvas, you can use the\n[CanvasRenderingContext2D.fill] or\n[CanvasRenderingContext2D.stroke] methods.", - "linewidth": "The\n**`CanvasRenderingContext2D.lineWidth`**\nproperty of the Canvas 2D API sets the thickness of lines.\n\n> **Note:** Lines can be drawn with the\n> [CanvasRenderingContext2D.stroke],\n> [CanvasRenderingContext2D.strokeRect],\n> and [CanvasRenderingContext2D.strokeText] methods.", - "measuretext": "The\n`CanvasRenderingContext2D.measureText()`\nmethod returns a [TextMetrics] object that contains information about the\nmeasured text (such as its width, for example).", - "miterlimit": "The **`CanvasRenderingContext2D.miterLimit`** property of the\nCanvas 2D API sets the miter limit ratio.\n\n> **Note:** For more info about miters, see [Applying styles and color](/en-US/docs/Web/API/Canvas_API/Tutorial/Applying_styles_and_colors) in the [Canvas tutorial](/en-US/docs/Web/API/Canvas_API/Tutorial).", - "moveto": "The\n**`CanvasRenderingContext2D.moveTo()`**\nmethod of the Canvas 2D API begins a new sub-path at the point specified by the given\n`(x, y)` coordinates.", - "putimagedata": "The **`CanvasRenderingContext2D.putImageData()`**\nmethod of the Canvas 2D API paints data from the given [ImageData] object\nonto the canvas. If a dirty rectangle is provided, only the pixels from that rectangle\nare painted. This method is not affected by the canvas transformation matrix.\n\n> **Note:** Image data can be retrieved from a canvas using the\n> [CanvasRenderingContext2D.getImageData] method.\n\nYou can find more information about `putImageData()` and general\nmanipulation of canvas contents in the article [Pixel manipulation with canvas](/en-US/docs/Web/API/Canvas_API/Tutorial/Pixel_manipulation_with_canvas).", - "quadraticcurveto": "The\n**`CanvasRenderingContext2D.quadraticCurveTo()`**\nmethod of the Canvas 2D API adds a quadratic [Bézier curve](/en-US/docs/Glossary/Bezier_curve) to the current\nsub-path. It requires two points: the first one is a control point and the second one is\nthe end point. The starting point is the latest point in the current path, which can be\nchanged using [CanvasRenderingContext2D.moveTo] before creating\nthe quadratic Bézier curve.", - "rect": "The\n**`CanvasRenderingContext2D.rect()`**\nmethod of the Canvas 2D API adds a rectangle to the current path.\n\nLike other methods that modify the current path, this method does not directly render\nanything. To draw the rectangle onto a canvas, you can use the\n[CanvasRenderingContext2D.fill] or\n[CanvasRenderingContext2D.stroke] methods.\n\n> **Note:** To both create and render a rectangle in one step, use the\n> [CanvasRenderingContext2D.fillRect] or\n> [CanvasRenderingContext2D.strokeRect] methods.", - "reset": "The **`CanvasRenderingContext2D.reset()`** method of the Canvas 2D API resets the rendering context to its default state, allowing it to be reused for drawing something else without having to explicitly reset all the properties.\n\nResetting clears the backing buffer, drawing state stack, any defined paths, and styles.\nThis includes the current [transformation](/en-US/docs/Web/API/CanvasRenderingContext2D#transformations) matrix, [compositing](/en-US/docs/Web/API/CanvasRenderingContext2D#compositing) properties, clipping region, dash list, [line styles](/en-US/docs/Web/API/CanvasRenderingContext2D#line_styles), [text styles](/en-US/docs/Web/API/CanvasRenderingContext2D#text_styles), [shadows](/en-US/docs/Web/API/CanvasRenderingContext2D#shadows), [image smoothing](/en-US/docs/Web/API/CanvasRenderingContext2D#image_smoothing), [filters](/en-US/docs/Web/API/CanvasRenderingContext2D#filters), and so on.", - "resettransform": "The\n**`CanvasRenderingContext2D.resetTransform()`**\nmethod of the Canvas 2D API resets the current transform to the identity matrix.", - "restore": "The\n**`CanvasRenderingContext2D.restore()`**\nmethod of the Canvas 2D API restores the most recently saved canvas state by popping the\ntop entry in the drawing state stack. If there is no saved state, this method does\nnothing.\n\nFor more information about the [drawing state](/en-US/docs/Web/API/CanvasRenderingContext2D/save#drawing_state), see [CanvasRenderingContext2D.save].", - "rotate": "The\n**`CanvasRenderingContext2D.rotate()`**\nmethod of the Canvas 2D API adds a rotation to the transformation matrix.", - "roundrect": "The **`CanvasRenderingContext2D.roundRect()`** method of the Canvas 2D API adds a rounded rectangle to the current path.\n\nThe radii of the corners can be specified in much the same way as the CSS [`border-radius`](/en-US/docs/Web/CSS/border-radius) property.\n\nLike other methods that modify the current path, this method does not directly render anything.\nTo draw the rounded rectangle onto a canvas, you can use the [CanvasRenderingContext2D.fill] or [CanvasRenderingContext2D.stroke] methods.", - "save": "The\n**`CanvasRenderingContext2D.save()`**\nmethod of the Canvas 2D API saves the entire state of the canvas by pushing the current\nstate onto a stack.\n\n### The drawing state\n\nThe drawing state that gets saved onto a stack consists of:\n\n- The current transformation matrix.\n- The current clipping region.\n- The current dash list.\n- The current values of the following attributes:\n [CanvasRenderingContext2D.strokeStyle],\n [CanvasRenderingContext2D.fillStyle],\n [CanvasRenderingContext2D.globalAlpha],\n [CanvasRenderingContext2D.lineWidth],\n [CanvasRenderingContext2D.lineCap],\n [CanvasRenderingContext2D.lineJoin],\n [CanvasRenderingContext2D.miterLimit],\n [CanvasRenderingContext2D.lineDashOffset],\n [CanvasRenderingContext2D.shadowOffsetX],\n [CanvasRenderingContext2D.shadowOffsetY],\n [CanvasRenderingContext2D.shadowBlur],\n [CanvasRenderingContext2D.shadowColor],\n [CanvasRenderingContext2D.globalCompositeOperation], [CanvasRenderingContext2D.font],\n [CanvasRenderingContext2D.textAlign],\n [CanvasRenderingContext2D.textBaseline],\n [CanvasRenderingContext2D.direction],\n [CanvasRenderingContext2D.imageSmoothingEnabled].", - "scale": "The\n**`CanvasRenderingContext2D.scale()`**\nmethod of the Canvas 2D API adds a scaling transformation to the canvas units\nhorizontally and/or vertically.\n\nBy default, one unit on the canvas is exactly one pixel. A scaling transformation\nmodifies this behavior. For instance, a scaling factor of 0.5 results in a unit size of\n0.5 pixels; shapes are thus drawn at half the normal size. Similarly, a scaling factor\nof 2.0 increases the unit size so that one unit becomes two pixels; shapes are thus\ndrawn at twice the normal size.", - "scrollpathintoview": "The\n**`CanvasRenderingContext2D.scrollPathIntoView()`**\nmethod of the Canvas 2D API scrolls the current or given path into view. It is similar\nto [Element.scrollIntoView].", - "setlinedash": "The **`setLineDash()`** method of the Canvas 2D API's\n[CanvasRenderingContext2D] interface sets the line dash pattern used when\nstroking lines. It uses an array of values that specify alternating lengths of lines\nand gaps which describe the pattern.\n\n> **Note:** To return to using solid lines, set the line dash list to an\n> empty array.", - "settransform": "The\n**`CanvasRenderingContext2D.setTransform()`**\nmethod of the Canvas 2D API resets (overrides) the current transformation to the\nidentity matrix, and then invokes a transformation described by the arguments of this\nmethod. This lets you scale, rotate, translate (move), and skew the context.\n\n> **Note:** See also the [CanvasRenderingContext2D.transform] method; instead of overriding the current transform matrix, it\n> multiplies it with a given one.", - "shadowblur": "The\n**`CanvasRenderingContext2D.shadowBlur`**\nproperty of the Canvas 2D API specifies the amount of blur applied to shadows. The\ndefault is `0` (no blur).\n\n> **Note:** Shadows are only drawn if the\n> [CanvasRenderingContext2D.shadowColor] property is set to\n> a non-transparent value. One of the `shadowBlur`,\n> [CanvasRenderingContext2D.shadowOffsetX], or\n> [CanvasRenderingContext2D.shadowOffsetY] properties must\n> be non-zero, as well.", - "shadowcolor": "The\n**`CanvasRenderingContext2D.shadowColor`**\nproperty of the Canvas 2D API specifies the color of shadows.\n\nBe aware that the shadow's rendered opacity will be affected by the opacity of the\n[CanvasRenderingContext2D.fillStyle] color when filling, and\nof the [CanvasRenderingContext2D.strokeStyle] color when\nstroking.\n\n> **Note:** Shadows are only drawn if the `shadowColor`\n> property is set to a non-transparent value. One of the\n> [CanvasRenderingContext2D.shadowBlur],\n> [CanvasRenderingContext2D.shadowOffsetX], or\n> [CanvasRenderingContext2D.shadowOffsetY] properties must\n> be non-zero, as well.", - "shadowoffsetx": "The\n**`CanvasRenderingContext2D.shadowOffsetX`**\nproperty of the Canvas 2D API specifies the distance that shadows will be offset\nhorizontally.\n\n> **Note:** Shadows are only drawn if the\n> [CanvasRenderingContext2D.shadowColor] property is set to\n> a non-transparent value. One of the [CanvasRenderingContext2D.shadowBlur], `shadowOffsetX`, or\n> [CanvasRenderingContext2D.shadowOffsetY] properties must\n> be non-zero, as well.", - "shadowoffsety": "The\n**`CanvasRenderingContext2D.shadowOffsetY`**\nproperty of the Canvas 2D API specifies the distance that shadows will be offset\nvertically.\n\n> **Note:** Shadows are only drawn if the\n> [CanvasRenderingContext2D.shadowColor] property is set to\n> a non-transparent value. One of the [CanvasRenderingContext2D.shadowBlur],\n> [CanvasRenderingContext2D.shadowOffsetX], or `shadowOffsetY` properties must be non-zero, as\n> well.", - "stroke": "The\n**`CanvasRenderingContext2D.stroke()`**\nmethod of the Canvas 2D API strokes (outlines) the current or given path with the\ncurrent stroke style.\n\nStrokes are aligned to the center of a path; in other words, half of the stroke is\ndrawn on the inner side, and half on the outer side.\n\nThe stroke is drawn using the [non-zero winding rule](https://en.wikipedia.org/wiki/Nonzero-rule), which\nmeans that path intersections will still get filled.", - "strokerect": "The\n**`CanvasRenderingContext2D.strokeRect()`**\nmethod of the Canvas 2D API draws a rectangle that is stroked (outlined) according to\nthe current [CanvasRenderingContext2D.strokeStyle] and other\ncontext settings.\n\nThis method draws directly to the canvas without modifying the current path, so any\nsubsequent [CanvasRenderingContext2D.fill] or\n[CanvasRenderingContext2D.stroke] calls will have no effect\non it.", - "strokestyle": "The **`CanvasRenderingContext2D.strokeStyle`** property of the\nCanvas 2D API specifies the color, gradient, or pattern to use for the strokes\n(outlines) around shapes. The default is `#000` (black).\n\n> **Note:** For more examples of stroke and fill styles, see [Applying styles and color](/en-US/docs/Web/API/Canvas_API/Tutorial/Applying_styles_and_colors) in the [Canvas tutorial](/en-US/docs/Web/API/Canvas_API/Tutorial).", - "stroketext": "The [CanvasRenderingContext2D] method\n**`strokeText()`**, part of the Canvas 2D API, strokes — that\nis, draws the outlines of — the characters of a text string at the specified\ncoordinates. An optional parameter allows specifying a maximum width for the rendered\ntext, which the will achieve by condensing the text or by\nusing a lower font size.\n\nThis method draws directly to the canvas without modifying the current path, so any\nsubsequent [CanvasRenderingContext2D.fill] or\n[CanvasRenderingContext2D.stroke] calls will have no effect\non it.\n\n> **Note:** Use the [CanvasRenderingContext2D.fillText] method to\n> fill the text characters rather than having just their outlines drawn.", - "textalign": "The\n**`CanvasRenderingContext2D.textAlign`**\nproperty of the Canvas 2D API specifies the current text alignment used when drawing\ntext.\n\nThe alignment is relative to the `x` value of the\n[CanvasRenderingContext2D.fillText] method. For example, if\n`textAlign` is `\"center\"`, then the text's left edge will be at\n`x - (textWidth / 2)`.", - "textbaseline": "The\n**`CanvasRenderingContext2D.textBaseline`**\nproperty of the Canvas 2D API specifies the current text baseline used when drawing\ntext.", - "textrendering": "The **`CanvasRenderingContext2D.textRendering`** property of the [Canvas API](/en-US/docs/Web/API/Canvas_API) provides information to the rendering engine about what to optimize for when rendering text.\n\nThe values correspond to the SVG [`text-rendering`](/en-US/docs/Web/SVG/Attribute/text-rendering) attribute (and CSS [`text-rendering`](/en-US/docs/Web/CSS/text-rendering) property).", - "transform": "The\n**`CanvasRenderingContext2D.transform()`**\nmethod of the Canvas 2D API multiplies the current transformation with the matrix\ndescribed by the arguments of this method. This lets you scale, rotate, translate\n(move), and skew the context.\n\n> **Note:** See also the\n> [CanvasRenderingContext2D.setTransform] method, which\n> resets the current transform to the identity matrix and then invokes\n> `transform()`.", - "translate": "The\n**`CanvasRenderingContext2D.translate()`**\nmethod of the Canvas 2D API adds a translation transformation to the current matrix.", - "wordspacing": "The **`CanvasRenderingContext2D.wordSpacing`** property of the [Canvas API](/en-US/docs/Web/API/Canvas_API) specifies the spacing between words when drawing text.\n\nThis corresponds to the CSS [`word-spacing`](/en-US/docs/Web/CSS/word-spacing) property." + "fontfamily": "The **`fontFamily`** property of the [CSSConditionRule] interface represents the name of the font family it applies to." } }, - "capturecontroller": { - "docs": "The **`CaptureController`** interface provides methods that can be used to further manipulate a capture session separate from its initiation via [MediaDevices.getDisplayMedia].\n\nA `CaptureController` object is associated with a capture session by passing it into a [MediaDevices.getDisplayMedia] call as the value of the options object's `controller` property.", + "CSSFontPaletteValuesRule": { + "docs": "The **`CSSFontPaletteValuesRule`** interface represents an [at-rule](/en-US/docs/Web/CSS/At-rule).", "properties": { - "setfocusbehavior": "The [CaptureController] interface's **`setFocusBehavior()`** method controls whether the captured tab or window will be focused when an associated [MediaDevices.getDisplayMedia] `Promise` fulfills, or whether the focus will remain with the tab containing the capturing app.\n\nYou can set this behavior multiple times before the [MediaDevices.getDisplayMedia] call, or once immediately after its `Promise` resolves. After that, the focus behavior is said to be finalized, and can't be changed." + "basepalette": "The read-only **`basePalette`** property of the [CSSFontPaletteValuesRule] interface indicates the base palette associated with the rule.", + "fontfamily": "The read-only **`fontFamily`** property of the [CSSFontPaletteValuesRule] interface lists the font families the rule can be applied to. The font families must be _named_ families; _generic_ families like `courier` are not valid.", + "name": "The read-only **`name`** property of the [CSSFontPaletteValuesRule] interface represents the name identifying the associated at-rule. A valid name always starts with two dashes, such as `--Alternate`.", + "overridecolors": "The read-only **`overrideColors`** property of the [CSSFontPaletteValuesRule] interface is a string containing a list of color index and color pair that are to be used instead. It is specified in the same format as the corresponding descriptor." } }, - "caretposition": { - "docs": "The `CaretPosition` interface represents the caret position, an indicator for the text insertion point. You can get a `CaretPosition` using the [Document.caretPositionFromPoint] method." - }, - "cdatasection": { - "docs": "The **`CDATASection`** interface represents a CDATA section\nthat can be used within XML to include extended portions of unescaped text.\nWhen inside a CDATA section, the symbols `<` and `&` don't need escaping\nas they normally do.\n\nIn XML, a CDATA section looks like:\n\n```xml\n\n```\n\nFor example:\n\n```html\n\n Here is a CDATA section: & ]]> with all kinds of unescaped text.\n\n```\n\nThe only sequence which is not allowed within a CDATA section is the closing sequence\nof a CDATA section itself, `]]>`.\n\n> **Note:** CDATA sections should not be used within HTML they are considered as comments and not displayed." - }, - "channelmergernode": { - "docs": "The `ChannelMergerNode` interface, often used in conjunction with its opposite, [ChannelSplitterNode], reunites different mono inputs into a single output. Each input is used to fill a channel of the output. This is useful for accessing each channels separately, e.g. for performing channel mixing where gain must be separately controlled on each channel.\n\n![Default channel merger node with six mono inputs combining to form a single output.](webaudiomerger.png)\n\nIf `ChannelMergerNode` has one single output, but as many inputs as there are channels to merge; the number of inputs is defined as a parameter of its constructor and the call to [BaseAudioContext/createChannelMerger]. In the case that no value is given, it will default to `6`.\n\nUsing a `ChannelMergerNode`, it is possible to create outputs with more channels than the rendering hardware is able to process. In that case, when the signal is sent to the [BaseAudioContext/listener] object, supernumerary channels will be ignored.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Number of inputsvariable; default to 6.
Number of outputs1
Channel count mode\"explicit\"
Channel count2 (not used in the default count mode)
Channel interpretation\"speakers\"
" + "CSSGroupingRule": { + "docs": "The **`CSSGroupingRule`** interface of the [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model) represents any CSS [at-rule](/en-US/docs/Web/CSS/At-rule) that contains other rules nested within it.", + "properties": { + "cssrules": "The **`cssRules`** property of the\n[CSSGroupingRule] interface returns a [CSSRuleList] containing\na collection of [CSSRule] objects.", + "deleterule": "The **`deleteRule()`** method of the\n[CSSGroupingRule] interface removes a CSS rule from a list of child CSS\nrules.", + "insertrule": "The **`insertRule()`** method of the\n[CSSGroupingRule] interface adds a new CSS rule to a list of CSS rules." + } }, - "channelsplitternode": { - "docs": "The `ChannelSplitterNode` interface, often used in conjunction with its opposite, [ChannelMergerNode], separates the different channels of an audio source into a set of mono outputs. This is useful for accessing each channel separately, e.g. for performing channel mixing where gain must be separately controlled on each channel.\n\n![Default channel splitter node with a single input splitting to form 6 mono outputs.](webaudiosplitter.png)\n\nIf your `ChannelSplitterNode` always has one single input, the amount of outputs is defined by a parameter on its constructor and the call to [BaseAudioContext/createChannelSplitter]. In the case that no value is given, it will default to `6`. If there are fewer channels in the input than there are outputs, supernumerary outputs are silent.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Number of inputs1
Number of outputsvariable; default to 6.
Channel count mode\n \"explicit\" Older implementations, as per earlier versions\n of the spec use \"max\".\n
Channel count\n Fixed to the number of outputs. Older implementations, as per earlier\n versions of the spec use 2 (not used in the default count\n mode).\n
Channel interpretation\"discrete\"
" + "CSSImageValue": { + "docs": "The **`CSSImageValue`** interface of the [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Object_Model#css_typed_object_model) represents values for properties that take an image, for example , , or .\n\nThe CSSImageValue object represents an [``](/en-US/docs/Web/CSS/image) that involves a URL, such as [`url()`](/en-US/docs/Web/CSS/url) or [`image()`](/en-US/docs/Web/CSS/image), but not [`linear-gradient()`](/en-US/docs/Web/CSS/gradient/linear-gradient) or [`element()`](/en-US/docs/Web/CSS/element)." }, - "characterboundsupdateevent": { - "docs": "The **`CharacterBoundsUpdateEvent`** interface is a [Event] that represents a request from the operating system to know the bounds of certain characters within an editable region that's attached to an [EditContext] instance.\n\nThis interface inherits properties from [Event].", + "CSSImportRule": { + "docs": "The **`CSSImportRule`** interface represents an [at-rule](/en-US/docs/Web/CSS/At-rule).", "properties": { - "rangeend": "The **`CharacterBoundsUpdateEvent.rangeEnd`** read-only property represents the offset of the last character within the editable text region for which the operating system needs the bounds.", - "rangestart": "The **`CharacterBoundsUpdateEvent.rangeStart`** read-only property represents the offset of the first character within the editable text region for which the operating system needs the bounds." + "href": "The read-only **`href`** property of the\n[CSSImportRule] interface returns the URL specified by the\n [at-rule](/en-US/docs/Web/CSS/At-rule).\n\nThe resolved URL will be the [`href`](/en-US/docs/Web/HTML/Element/link#href) attribute of the\nassociated stylesheet.", + "layername": "The read-only **`layerName`** property of the [CSSImportRule] interface returns the name of the cascade layer created by the [at-rule](/en-US/docs/Web/CSS/At-rule).\n\nIf the created layer is anonymous, the string is empty (`\"\"`), if no layer has been\ncreated, it is the `null` object.", + "media": "The read-only **`media`** property of the\n[CSSImportRule] interface returns a [MediaList] object,\ncontaining the value of the `media` attribute of the associated stylesheet.", + "stylesheet": "The read-only **`styleSheet`** property of the\n[CSSImportRule] interface returns the CSS Stylesheet specified by the\n [at-rule](/en-US/docs/Web/CSS/At-rule). This will be\nin the form of a [CSSStyleSheet] object.\n\nAn [at-rule](/en-US/docs/Web/CSS/At-rule) always has\nan associated stylesheet.", + "supportstext": "The read-only **`supportsText`** property of the [CSSImportRule] interface returns the supports condition specified by the [at-rule](/en-US/docs/Web/CSS/At-rule)." } }, - "characterdata": { - "docs": "The **`CharacterData`** abstract interface represents a [Node] object that contains characters. This is an abstract interface, meaning there aren't any objects of type `CharacterData`: it is implemented by other interfaces like [Text], [Comment], [CDATASection], or [ProcessingInstruction], which aren't abstract.", + "CSSKeyframeRule": { + "docs": "The **`CSSKeyframeRule`** interface describes an object representing a set of styles for a given keyframe. It corresponds to the contents of a single keyframe of a [at-rule](/en-US/docs/Web/CSS/At-rule).", "properties": { - "after": "The **`after()`** method of the [CharacterData] interface\ninserts a set of [Node] objects or strings in the children list of the\nobject's parent, just after the object itself.\n\nStrings are inserted as [Text] nodes; the string is being passed as argument to the [Text/Text] constructor.", - "appenddata": "The **`appendData()`** method of the [CharacterData] interface\nadds the provided data to the end of the node's current data.", - "before": "The **`before()`** method of the [CharacterData] interface\ninserts a set of [Node] objects and strings\nin the children list of the `CharacterData`'s parent, just before the `CharacterData` node.\n\nStrings are inserted as [Text] nodes; the string is being passed as argument to the [Text/Text] constructor.", - "data": "The **`data`** property of the [CharacterData] interface represent the value of the current object's data.", - "deletedata": "The **`deleteData()`** method of the [CharacterData] interface\nremoves all or part of the data from this `CharacterData` node.", - "insertdata": "The **`insertData()`** method of the [CharacterData] interface\ninserts the provided data into this `CharacterData` node's current data,\nat the provided offset from the start of the existing data.\nThe provided data is spliced into the existing data.", - "length": "The read-only **`CharacterData.length`** property\nreturns the number of characters in the contained data, as a positive integer.", - "nextelementsibling": "The read-only **`nextElementSibling`** property of the [CharacterData] interface\nreturns the first [Element] node following the specified one in its parent's\nchildren list, or `null` if the specified element is the last one in the list.", - "previouselementsibling": "The read-only **`previousElementSibling`** of the [CharacterData] interface\nreturns the first [Element] before the current node in its parent's children list,\nor `null` if there is none.", - "remove": "The **`remove()`** method of the [CharacterData] removes the text contained in the node.", - "replacedata": "The **`replaceData()`** method of the [CharacterData] interface removes a certain number of characters of the existing text in a given `CharacterData` node and replaces those characters with the text provided.", - "replacewith": "The **`replaceWith()`** method of the [CharacterData] interface\nreplaces this node in the children list of its parent\nwith a set of [Node] objects or string.\n\nStrings are inserted as [Text] nodes; the string is being passed as argument to the [Text/Text] constructor.", - "substringdata": "The **`substringData()`** method of the [CharacterData] interface\nreturns a portion of the existing data,\nstarting at the specified index\nand extending for a given number of characters afterwards." + "keytext": "The **`keyText`** property of the [CSSKeyframeRule] interface represents the keyframe selector as a comma-separated list of percentage values. The from and to keywords map to 0% and 100%, respectively.", + "style": "The read-only **`CSSKeyframeRule.style`** property is the [CSSStyleDeclaration] interface for the [declaration block](https://www.w3.org/TR/1998/REC-CSS2-19980512/syndata.html#block) of the [CSSKeyframeRule]." } }, - "client": { - "docs": "The `Client` interface represents an executable context such as a [Worker], or a [SharedWorker]. [Window] clients are represented by the more-specific [WindowClient]. You can get `Client`/`WindowClient` objects from methods such as [Clients.matchAll] and [Clients.get].", + "CSSKeyframesRule": { + "docs": "The **`CSSKeyframesRule`** interface describes an object representing a complete set of keyframes for a CSS animation. It corresponds to the contents of a whole [at-rule](/en-US/docs/Web/CSS/At-rule).", "properties": { - "frametype": "The **`frameType`** read-only property of the [Client] interface indicates the type of browsing context of the current [Client]. This value can be one of `\"auxiliary\"`, `\"top-level\"`, `\"nested\"`, or `\"none\"`.", - "id": "The **`id`** read-only property of the [Client] interface returns the universally unique identifier of the [Client] object.", - "postmessage": "The **`postMessage()`** method of the\n[Client] interface allows a service worker to send a message to a client\n(a [Window], [Worker], or [SharedWorker]). The\nmessage is received in the \"`message`\" event on\n[ServiceWorkerContainer].", - "type": "The **`type`** read-only property of the [Client]\ninterface indicates the type of client the service worker is controlling.", - "url": "The **`url`** read-only property of the [Client]\ninterface returns the URL of the current service worker client." + "appendrule": "The **`appendRule()`** method of the [CSSKeyframeRule] interface appends a [CSSKeyFrameRule] to the end of the rules.", + "cssrules": "The read-only **`cssRules`** property of the [CSSKeyframeRule] interface returns a [CSSRuleList] containing the rules in the keyframes [at-rule](/en-US/docs/Web/CSS/At-rule).", + "deleterule": "The **`deleteRule()`** method of the [CSSKeyframeRule] interface deletes the [CSSKeyFrameRule] that matches the specified keyframe selector.", + "findrule": "The **`findRule()`** method of the [CSSKeyframeRule] interface finds the [CSSKeyFrameRule] that matches the specified keyframe selector.", + "name": "The **`name`** property of the [CSSKeyframeRule] interface gets and sets the name of the animation as used by the property." } }, - "clients": { - "docs": "The `Clients` interface provides access to [Client] objects. Access it via `[ServiceWorkerGlobalScope].clients` within a [service worker](/en-US/docs/Web/API/Service_Worker_API).", + "CSSKeywordValue": { + "docs": "The **`CSSKeywordValue`** interface of the [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Object_Model#css_typed_object_model) creates an object to represent CSS keywords and other identifiers.\n\nThe interface instance name is a meaning that when used anywhere a string is expected it will return the value of `CSSKeyword.value`.", "properties": { - "claim": "The **`claim()`** method of the [Clients] interface allows an active service worker to set itself as the [ServiceWorkerContainer.controller] for all clients within its [ServiceWorkerRegistration.scope].\nThis triggers a \"`controllerchange`\" event on [ServiceWorkerContainer] in any clients that become controlled by this service worker.\n\nWhen a service worker is initially registered, pages won't use it until they next\nload. The `claim()` method causes those pages to be controlled immediately.\nBe aware that this results in your service worker controlling pages that loaded\nregularly over the network, or possibly via a different service worker.", - "get": "The **`get()`** method of the\n[Clients] interface gets a service worker client matching a given\n`id` and returns it in a `Promise`.", - "matchall": "The **`matchAll()`** method of the [Clients]\ninterface returns a `Promise` for a list of service worker\n[Client] objects. Include the `options` parameter to return all service worker\nclients whose origin is the same as the associated service worker's origin. If options\nare not included, the method returns only the service worker clients controlled by the\nservice worker.", - "openwindow": "The **`openWindow()`** method of the [Clients]\ninterface creates a new top level browsing context and loads a given URL. If the calling\nscript doesn't have permission to show popups, `openWindow()` will throw an\n`InvalidAccessError`.\n\nIn Firefox, the method is allowed to show popups only when called as the result of a\nnotification click event.\n\nIn Chrome for Android, the method may instead open the URL in an existing browsing\ncontext provided by a [standalone web app](/en-US/docs/Web/Progressive_web_apps) previously added to the user's home screen. As of recently, this also works on\nChrome for Windows." + "value": "The **`value`** property of the\n[CSSKeywordValue] interface returns or sets the value of the\n`CSSKeywordValue`." } }, - "clipboard": { - "docs": "The **`Clipboard`** interface of the [Clipboard API](/en-US/docs/Web/API/Clipboard_API) provides read and write access to the contents of the system clipboard.\nThis allows a web application to implement cut, copy, and paste features.\n\nThe system clipboard is exposed through the global [Navigator.clipboard] property.\n\nAll of the Clipboard API methods operate asynchronously; they return a `Promise` which is resolved once the clipboard access has been completed.\nThe promise is rejected if clipboard access is denied.\n\nAll the methods require a [secure context](/en-US/docs/Web/Security/Secure_Contexts).\nAdditional requirements for using the API are discussed in the [Security consideration](/en-US/docs/Web/API/Clipboard_API#security_considerations) section of the API overview topic.", + "CSSLayerBlockRule": { + "docs": "The **`CSSLayerBlockRule`** represents a block rule. It is a grouping at-rule meaning that it can contain other rules, and is associated to a given cascade layer, identified by its _name_.", "properties": { - "read": "The **`read()`** method of the [Clipboard] interface requests a copy of the clipboard's contents, fulfilling the returned `Promise` with the data.\n\nThe method can in theory return arbitrary data (unlike [Clipboard.readText], which can only return text).\nBrowsers commonly support reading text, HTML, and PNG image data — see [browser compatibility](#browser_compatibility) for more information.", - "readtext": "The **`readText()`** method of the [Clipboard] interface returns a `Promise` which fulfils with a copy of the textual contents of the system clipboard.\n\n> **Note:** To read non-text contents from the clipboard, use the [Clipboard.read] method instead.\n> You can write text to the clipboard using [Clipboard.writeText].", - "write": "The **`write()`** method of the [Clipboard] interface writes arbitrary data to the clipboard, such as images, fulfilling the returned `Promise` on completion.\nThis can be used to implement cut and copy functionality.\n\nThe method can in theory write arbitrary data (unlike [Clipboard.writeText], which can only write text).\nBrowsers commonly support writing text, HTML, and PNG image data — see [browser compatibility](#browser_compatibility) for more information.", - "writetext": "The **`writeText()`** method of the [Clipboard] interface writes the specified text to the system clipboard, returning a `Promise` that is resolved once the system clipboard has been updated." + "name": "The read-only **`name`** property of the [CSSLayerBlockRule] interface represents the name of the associated cascade layer." } }, - "clipboardevent": { - "docs": "The **`ClipboardEvent`** interface of the [Clipboard API](/en-US/docs/Web/API/Clipboard_API) represents events providing information related to modification of the clipboard, that is [Element/cut_event], [Element/copy_event], and [Element/paste_event] events.", + "CSSLayerStatementRule": { + "docs": "The **`CSSLayerStatementRule`** represents a statement rule. Unlike [CSSLayerBlockRule], it doesn't contain other rules and merely defines one or several layers by providing their names.\n\nThis rule allows to explicitly declare the ordering layer that is in an apparent way at the beginning of a CSS file: the layer order is defined by the order of first occurrence of each layer name. Declaring them with a statement allows the reader to understand the layer order. It also allows inline and imported layers to be interleaved, which is not possible when using the `CSSLayerBlockRule` syntax.", "properties": { - "clipboarddata": "The **`clipboardData`** property of the [ClipboardEvent] interface holds a [DataTransfer] object, which can be used to:\n\n- specify what data should be put into the clipboard from the [Element/cut_event] and [Element/copy_event] event handlers, typically with a [DataTransfer.setData] call;\n- obtain the data to be pasted from the [Element/paste_event] event handler, typically with a [DataTransfer.getData] call.\n\nSee the [Element/cut_event], [Element/copy_event], and [Element/paste_event] events documentation for more information." + "namelist": "The read-only **`nameList`** property of the [CSSLayerStatementRule] interface return the list of associated cascade layer names. The names can't be modified." } }, - "clipboarditem": { - "docs": "The **`ClipboardItem`** interface of the [Clipboard API](/en-US/docs/Web/API/Clipboard_API) represents a single item format, used when reading or writing clipboard data using [clipboard.read] and [clipboard.write] respectively.\n\nThe benefit of having the **`ClipboardItem`** interface to represent data, is that it enables developers to cope with the varying scope of file types and data.\n\n> **Note:** To work with text see the [Clipboard.readText] and [Clipboard.writeText] methods of the [Clipboard] interface.", + "CSSMathInvert": { + "docs": "The **`CSSMathInvert`** interface of the represents a CSS `calc()` used as `calc(1 / ).` It inherits properties and methods from its parent [CSSNumericValue].", "properties": { - "gettype": "The **`getType()`** method of the [ClipboardItem] interface returns a `Promise` that resolves with a [Blob] of the requested or an error if the MIME type is not found.", - "presentationstyle": "The read-only **`presentationStyle`** property of the [ClipboardItem] interface returns a string indicating how an item should be presented.\n\nFor example, in some contexts an image might be displayed inline, while in others it might be represented as an attachment.", - "types": "The read-only **`types`** property of the [ClipboardItem] interface returns an `Array` of available within the [ClipboardItem]" + "value": "The CSSMathInvert.value read-only property of the\n[CSSMathInvert] interface returns a [CSSNumericValue] object." } }, - "closeevent": { - "docs": "A `CloseEvent` is sent to clients using when the connection is closed. This is delivered to the listener indicated by the `WebSocket` object's `onclose` attribute.", + "CSSMathMax": { + "docs": "The **`CSSMathMax`** interface of the represents the CSS `max()` function. It inherits properties and methods from its parent [CSSNumericValue].", "properties": { - "code": "The **`code`** read-only property of the [CloseEvent] interface returns a [WebSocket connection close code](https://www.rfc-editor.org/rfc/rfc6455.html#section-7.1.5) indicating the reason the server gave for closing the connection.", - "reason": "The **`reason`** read-only property of the [CloseEvent] interface returns the [WebSocket connection close reason](https://www.rfc-editor.org/rfc/rfc6455.html#section-7.1.6) the server gave for closing the connection; that is, a concise human-readable prose explanation for the closure.", - "wasclean": "The **`wasClean`** read-only property of the [CloseEvent] interface returns `true` if the connection closed cleanly." + "values": "The CSSMathMax.values read-only property of the\n[CSSMathMax] interface returns a [CSSNumericArray] object\nwhich contains one or more [CSSNumericValue] objects." } }, - "comment": { - "docs": "The **`Comment`** interface represents textual notations within markup; although it is generally not visually shown, such comments are available to be read in the source view.\n\nComments are represented in HTML and XML as content between '``'. In XML, like inside SVG or MathML markup, the character sequence '`--`' cannot be used within a comment." - }, - "compositionevent": { - "docs": "The DOM **`CompositionEvent`** represents events that occur due to the user indirectly entering text.", + "CSSMathMin": { + "docs": "The **`CSSMathMin`** interface of the represents the CSS `min()` function. It inherits properties and methods from its parent [CSSNumericValue].", "properties": { - "data": "The **`data`** read-only property of the\n[CompositionEvent] interface returns the characters generated by the input\nmethod that raised the event; its exact nature varies depending on the type of event\nthat generated the `CompositionEvent` object.", - "initcompositionevent": "The **`initCompositionEvent()`**\nmethod of the [CompositionEvent] interface initializes the attributes of a\n`CompositionEvent` object instance.\n\n> **Note:** The correct way of creating a [CompositionEvent] is to use\n> the constructor [CompositionEvent.CompositionEvent].", - "locale": "The **`locale`** read-only property of the\n[CompositionEvent] interface returns the locale of current input method\n(for example, the keyboard layout locale if the composition is associated with ).\n\n> **Warning:** Even for browsers supporting it, don't trust the value contained in this property.\n> Even if technically it is accessible, the way to set it up when creating a [CompositionEvent]\n> is not guaranteed to be coherent." + "values": "The CSSMathMin.values read-only property of the\n[CSSMathMin] interface returns a [CSSNumericArray] object\nwhich contains one or more [CSSNumericValue] objects." } }, - "compressionstream": { - "docs": "The **`CompressionStream`** interface of the [Compression Streams API] is an API for compressing a stream of data.", + "CSSMathNegate": { + "docs": "The **`CSSMathNegate`** interface of the negates the value passed into it. It inherits properties and methods from its parent [CSSNumericValue].", "properties": { - "readable": "The **`readable`** read-only property of the [CompressionStream] interface returns a [ReadableStream].", - "writable": "The **`writable`** read-only property of the [CompressionStream] interface returns a [WritableStream]." + "value": "The CSSMathNegate.value read-only property of the\n[CSSMathNegate] interface returns a [CSSNumericValue] object." } }, - "console": { - "docs": "The **`console`** object provides access to the debugging console (e.g., the [Web console](https://firefox-source-docs.mozilla.org/devtools-user/web_console/index.html) in Firefox). The specifics of how it works vary from browser to browser or server runtimes (Node.js, for example), but there is a _de facto_ set of features that are typically provided.\n\nThe `console` object can be accessed from any global object. [Window] on browsing scopes and [WorkerGlobalScope] as specific variants in workers via the property console. It's exposed as [Window.console], and can be referenced as `console`. For example:\n\n```js\nconsole.log(\"Failed to open the specified link\");\n```\n\nThis page documents the [Methods](#methods) available on the `console` object and gives a few [Usage](#usage) examples.\n\n> **Note:** Certain online IDEs and editors may implement the console API differently than the browsers. As a result, certain functionality of the console API, such as the timer methods, may not be outputted in the console of online IDEs or editors. Always open your browser's DevTools console to see the logs as shown in this documentation.", + "CSSMathProduct": { + "docs": "The **`CSSMathProduct`** interface of the represents the result obtained by calling [CSSNumericValue.add], [CSSNumericValue.sub], or [CSSNumericValue.toSum] on [CSSNumericValue]. It inherits properties and methods from its parent [CSSNumericValue].", "properties": { - "assert_static": "The **`console.assert()`** static method writes an error message to the console if the assertion is false. If the assertion is true, nothing happens.", - "clear_static": "The **`console.clear()`** static method clears the console if the console allows it. A graphical console, like those running on browsers, will allow it; a console displaying on the terminal, like the one running on Node, will not support it, and will have no effect (and no error).", - "count_static": "The **`console.count()`** static method logs the number of times that this particular call to `count()` has been called.", - "countreset_static": "The **`console.countReset()`** static method resets counter used with [console/count_static].", - "debug_static": "The **`console.debug()`** static method outputs a message to the console at the \"debug\" log level. The message is only displayed to the user if the console is configured to display debug output. In most cases, the log level is configured within the console UI. This log level might correspond to the `Debug` or `Verbose` log level.", - "dir_static": "The **`console.dir()`** static method displays an interactive list of the properties of the specified JavaScript object. The output is presented as a hierarchical listing with disclosure triangles that let you see the contents of child objects.\n\nIn other words, `console.dir()` is the way to see all the properties of a specified JavaScript object in console by which the developer can easily get the properties of the object.\n\n![A screenshot of the Firefox console where console.dir(document.location) is run. We can see the URL of the page, followed by a block of properties. If the property is a function or an object, a disclosure triangle is prepended.](console-dir.png)", - "dirxml_static": "The **`console.dirxml()`** static method displays an interactive tree of the descendant elements of the specified XML/HTML element. If it is not possible to display as an element the JavaScript Object view is shown instead. The output is presented as a hierarchical listing of expandable nodes that let you see the contents of child nodes.", - "error_static": "The **`console.error()`** static method outputs an error message to the console.", - "group_static": "The **`console.group()`** static method creates a new inline group in the [Web console](https://firefox-source-docs.mozilla.org/devtools-user/web_console/index.html) log, causing any subsequent console messages to be indented by an additional level, until [console/groupend_static] is called.", - "groupcollapsed_static": "The **`console.groupCollapsed()`** static method creates a new inline group in the console. Unlike [console/group_static], however, the new group is created collapsed. The user will need to use the disclosure button next to it to expand it, revealing the entries created in the group.\n\nCall [console/groupEnd_static] to back out to the parent group.\n\nSee [Using groups in the console](/en-US/docs/Web/API/console#using_groups_in_the_console) in the [console] documentation for details and examples.", - "groupend_static": "The **`console.groupEnd()`** static method exits the current inline group in the console. See [Using groups in the console](/en-US/docs/Web/API/console#using_groups_in_the_console) in the [console] documentation for details and examples.", - "info_static": "The **`console.info()`** static method outputs an informational message to the console. In Firefox, a small \"i\" icon is displayed next to these items in the console's log.", - "log_static": "The **`console.log()`** static method outputs a message to the console. The message may be a single string (with optional substitution values), or it may be any one or more JavaScript objects.", - "profile_static": "The **`console.profile()`** static method starts recording a performance profile (for example, the [Firefox performance tool](https://firefox-source-docs.mozilla.org/devtools-user/performance/index.html)).\n\nYou can optionally supply an argument to name the profile and this then enables you to stop only that profile if multiple profiles being recorded. See [console/profileEnd_static] to see how this argument is interpreted.\n\nTo stop recording call [console/profileEnd_static].", - "profileend_static": "The **`console.profileEnd()`** static method stops recording a profile previously started with [console/profile_static].\n\nYou can optionally supply an argument to name the profile. Doing so enables you to stop only that profile if you have multiple profiles being recorded.\n\n- If `console.profileEnd()` is passed a profile name, and it matches the name of a profile being recorded, then that profile is stopped.\n- If `console.profileEnd()` is passed a profile name and it does not match the name of a profile being recorded, no changes will be made.\n- If `console.profileEnd()` is not passed a profile name, the most recently started profile is stopped.", - "table_static": "The **`console.table()`** static method displays tabular data as a table.\n\nThis function takes one mandatory argument `data`, which must be an array or an object, and one additional optional parameter `columns`.\n\nIt logs `data` as a table. Each element in the array (or enumerable property if `data` is an object) will be a row in the table.\n\nThe first column in the table will be labeled `(index)`. If `data` is an array, then its values will be the array indices. If `data` is an object, then its values will be the property names. Note that (in Firefox) `console.table` is limited to displaying 1000 rows (first row is the labeled index).\n\n### Collections of primitive types\n\nThe `data` argument may be an array or an object.\n\n```js\n// an array of strings\n\nconsole.table([\"apples\", \"oranges\", \"bananas\"]);\n```\n\n| (index) | Values |\n| ------- | --------- |\n| 0 | 'apples' |\n| 1 | 'oranges' |\n| 2 | 'bananas' |\n\n```js\n// an object whose properties are strings\n\nfunction Person(firstName, lastName) {\n this.firstName = firstName;\n this.lastName = lastName;\n}\n\nconst me = new Person(\"Tyrone\", \"Jones\");\n\nconsole.table(me);\n```\n\n| (index) | Values |\n| --------- | -------- |\n| firstName | 'Tyrone' |\n| lastName | 'Jones' |\n\n### Collections of compound types\n\nIf the elements in the array, or properties in the object, are themselves arrays or objects, then their elements or properties are enumerated in the row, one per column:\n\n```js\n// an array of arrays\n\nconst people = [\n [\"Tyrone\", \"Jones\"],\n [\"Janet\", \"Smith\"],\n [\"Maria\", \"Cruz\"],\n];\nconsole.table(people);\n```\n\n| (index) | 0 | 1 |\n| ------- | -------- | ------- |\n| 0 | 'Tyrone' | 'Jones' |\n| 1 | 'Janet' | 'Smith' |\n| 2 | 'Maria' | 'Cruz' |\n\n```js\n// an array of objects\n\nfunction Person(firstName, lastName) {\n this.firstName = firstName;\n this.lastName = lastName;\n}\n\nconst tyrone = new Person(\"Tyrone\", \"Jones\");\nconst janet = new Person(\"Janet\", \"Smith\");\nconst maria = new Person(\"Maria\", \"Cruz\");\n\nconsole.table([tyrone, janet, maria]);\n```\n\nNote that if the array contains objects, then the columns are labeled with the property name.\n\n| (index) | firstName | lastName |\n| ------- | --------- | -------- |\n| 0 | 'Tyrone' | 'Jones' |\n| 1 | 'Janet' | 'Smith' |\n| 2 | 'Maria' | 'Cruz' |\n\n```js\n// an object whose properties are objects\n\nconst family = {};\n\nfamily.mother = new Person(\"Janet\", \"Jones\");\nfamily.father = new Person(\"Tyrone\", \"Jones\");\nfamily.daughter = new Person(\"Maria\", \"Jones\");\n\nconsole.table(family);\n```\n\n| (index) | firstName | lastName |\n| -------- | --------- | -------- |\n| daughter | 'Maria' | 'Jones' |\n| father | 'Tyrone' | 'Jones' |\n| mother | 'Janet' | 'Jones' |\n\n### Restricting the columns displayed\n\nBy default, `console.table()` lists all elements in each row. You can use the optional `columns` parameter to select a subset of columns to display:\n\n```js\n// an array of objects, logging only firstName\n\nfunction Person(firstName, lastName) {\n this.firstName = firstName;\n this.lastName = lastName;\n}\n\nconst tyrone = new Person(\"Tyrone\", \"Jones\");\nconst janet = new Person(\"Janet\", \"Smith\");\nconst maria = new Person(\"Maria\", \"Cruz\");\n\nconsole.table([tyrone, janet, maria], [\"firstName\"]);\n```\n\n| (index) | firstName |\n| ------- | --------- |\n| 0 | 'Tyrone' |\n| 1 | 'Janet' |\n| 2 | 'Maria' |\n\n### Sorting columns\n\nYou can sort the table by a particular column by clicking on that column's label.", - "time_static": "The **`console.time()`** static method starts a timer you can use to track how long an operation takes. You give each timer a unique name, and may have up to 10,000 timers running on a given page. When you call [console/timeEnd_static] with the same name, the browser will output the time, in milliseconds, that elapsed since the timer was started.\n\nSee [Timers](/en-US/docs/Web/API/console#timers) in the [console] documentation for details and examples.", - "timeend_static": "The **`console.timeEnd()`** static method stops a timer that was previously started by calling [console/time_static].\n\nSee [Timers](/en-US/docs/Web/API/console#timers) in the documentation for details and examples.", - "timelog_static": "The **`console.timeLog()`** static method logs the current value of a timer that was previously started by calling [console/time_static].", - "timestamp_static": "The **`console.timeStamp()`** static method adds a single marker to the browser's Performance tool ([Firefox](https://profiler.firefox.com/docs/#/), [Chrome](https://developer.chrome.com/docs/devtools/evaluate-performance/reference/)). This lets you correlate a point in your code with the other events recorded in the timeline, such as layout and paint events.\n\nYou can optionally supply an argument to label the timestamp, and this label will then be shown alongside the marker.", - "trace_static": "The **`console.trace()`** static method outputs a stack trace to the console.\n\n> **Note:** In some browsers, `console.trace()` may also output the sequence of calls and asynchronous events leading to the current `console.trace()` which are not on the call stack — to help identify the origin of the current event evaluation loop.\n\nSee [Stack traces](/en-US/docs/Web/API/console#stack_traces) in the [console] documentation for details and examples.", - "warn_static": "The **`console.warn()`** static method outputs a warning message to the console.\n\n> **Note:** In Chrome and Firefox, warnings have a small exclamation point icon next to them in the console log." + "values": "The **`CSSMathProduct.values`** read-only\nproperty of the [CSSMathProduct] interface returns a\n[CSSNumericArray] object which contains one or more\n[CSSNumericValue] objects." } }, - "constantsourcenode": { - "docs": "The `ConstantSourceNode` interface—part of the Web Audio API—represents an audio source (based upon [AudioScheduledSourceNode]) whose output is single unchanging value. This makes it useful for cases in which you need a constant value coming in from an audio source. In addition, it can be used like a constructible [AudioParam] by automating the value of its [ConstantSourceNode.offset] or by connecting another node to it; see [Controlling multiple parameters with ConstantSourceNode](/en-US/docs/Web/API/Web_Audio_API/Controlling_multiple_parameters_with_ConstantSourceNode).\n\nA `ConstantSourceNode` has no inputs and exactly one monaural (one-channel) output. The output's value is always the same as the value of the [ConstantSourceNode.offset] parameter.\n\n\n \n \n \n \n \n \n \n \n \n \n
Number of inputs0
Number of outputs1
", + "CSSMathSum": { + "docs": "The **`CSSMathSum`** interface of the represents the result obtained by calling [CSSNumericValue.add], [CSSNumericValue.sub], or [CSSNumericValue.toSum] on [CSSNumericValue].\n\nA CSSMathSum is the object type returned when the [`StylePropertyMapReadOnly.get()`](/en-US/docs/Web/API/StylePropertyMapReadOnly/get) method is used on a CSS property whose value is created with a [`calc()`](/en-US/docs/Web/CSS/calc) function.", "properties": { - "offset": "The read-only `offset` property of the [ConstantSourceNode]\ninterface returns a [AudioParam] object indicating the numeric [a-rate](/en-US/docs/Web/API/AudioParam#a-rate) value which is always returned\nby the source when asked for the next sample.\n\n> **Note:** While the `AudioParam` named `offset` is read-only, the\n> `value` property within is not. So you can change the value of\n> `offset` by setting the value of\n> `ConstantSourceNode.offset.value`:\n>\n> ```js\n> myConstantSourceNode.offset.value = newValue;\n> ```" + "values": "The **`CSSMathSum.values`** read-only property\nof the [CSSMathSum] interface returns a [CSSNumericArray]\nobject which contains one or more [CSSNumericValue] objects." } }, - "contactaddress": { - "docs": "The **`ContactAddress`** interface of the [Contact Picker API](/en-US/docs/Web/API/Contact_Picker_API) represents a physical address. Instances of this interface are retrieved from the `address` property of the objects returned by [ContactsManager.getProperties].\n\nIt may be useful to refer to the Universal Postal Union website's [Addressing S42 standard](https://www.upu.int/en/Postal-Solutions/Programmes-Services/Addressing-Solutions#addressing-s42-standard) materials, which provide information about international standards for postal addresses.", + "CSSMathValue": { + "docs": "The **`CSSMathValue`** interface of the a base class for classes representing complex numeric values.", "properties": { - "addressline": "The **`addressLine`** read-only property of the [ContactAddress] interface is an array of strings, each specifying a line of the address that is not covered by one of the other properties of `ContactAddress`. The array may include the street name, the house number, apartment number, the rural delivery route, descriptive instructions, or the post office box.", - "city": "The **`city`** read-only property of the [ContactAddress] interface returns a string containing the city or town portion of the address.", - "country": "The **`country`** read-only property of the [ContactAddress] interface is a string identifying the address's country using the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) standard. The string is always in its canonical upper-case form.\n\nSome examples of valid `country` values: `\"US\"`, `\"GB\"`, `\"CN\"`, or `\"JP\"`.", - "dependentlocality": "The read-only **`dependentLocality`** property of the [ContactAddress] interface is a string containing a locality or sublocality designation within a city, such as a neighborhood, borough, district, or, in the United Kingdom, a dependent locality. Also known as a _post town_.", - "organization": "The **`organization`** read-only property of the [ContactAddress] interface returns a string containing the name of the organization, firm, company, or institution at the address.", - "phone": "The read-only **`phone`** property of the [ContactAddress] interface returns a string containing the telephone number of the recipient or contact person at the address.", - "postalcode": "The **`postalCode`** read-only property of the [ContactAddress] interface returns a string containing a code used by a jurisdiction for mail routing, for example, the [ZIP Code](https://en.wikipedia.org/wiki/ZIP_Code) in the United States or the [Postal Index Number](https://en.wikipedia.org/wiki/Postal_Index_Number) (PIN code) in India.", - "recipient": "The read-only **`recipient`** property of the [ContactAddress] interface returns a string containing the name of the recipient, purchaser, or contact person at the address.", - "region": "The read-only **`region`** property of the [ContactAddress] interface returns a string containing the top-level administrative subdivision of the country in which the address is located. This may be a state, province, oblast, or prefecture.", - "sortingcode": "The **`sortingCode`** read-only property of the [ContactAddress] interface returns a string containing a postal sorting code such as is used in France.", - "tojson": "The **`toJSON()`** method of the [ContactAddress] interface is a standard serializer that returns a JSON representation of the `ContactAddress` object's properties." + "operator": "The **`CSSMathValue.operator`** read-only\nproperty of the [CSSMathValue] interface indicates the operator that the\ncurrent subtype represents. For example, if the current `CSSMathValue`\nsubtype is `CSSMathSum`, this property will return the string\n`\"sum\"`." } }, - "contactsmanager": { - "docs": "The **`ContactsManager`** interface of the [Contact Picker API] allows users to select entries from their contact list and share limited details of the selected entries with a website or application.\n\nThe `ContactsManager` is available through the global [navigator.contacts] property.", + "CSSMatrixComponent": { + "docs": "The **`CSSMatrixComponent`** interface of the represents the [matrix()](/en-US/docs/Web/CSS/transform-function/matrix) and [matrix3d()](/en-US/docs/Web/CSS/transform-function/matrix3d) values of the individual `transform` property in CSS. It inherits properties and methods from its parent [CSSTransformValue].", "properties": { - "getproperties": "The **`getProperties()`** method of the\n[ContactsManager] interface returns a `Promise` which resolves\nwith an `Array` of `strings` indicating which contact\nproperties are available.", - "select": "The **`select()`** method of the\n[ContactsManager] interface returns a `Promise` which, when\nresolved, presents the user with a contact picker which allows them to select contact(s)\nthey wish to share. This method requires a user gesture for the `Promise` to\nresolve." + "matrix": "The **`matrix`** property of the\n[CSSMatrixComponent] interface gets and sets a 2d or 3d matrix.\n\nSee the [matrix()](/en-US/docs/Web/CSS/transform-function/matrix) and [matrix3d()](/en-US/docs/Web/CSS/transform-function/matrix3d) pages for\nexamples." } }, - "contentindex": { - "docs": "The **`ContentIndex`** interface of the [Content Index API](/en-US/docs/Web/API/Content_Index_API) allows developers to register their offline enabled content with the browser.", + "CSSMediaRule": { + "docs": "The **`CSSMediaRule`** interface represents a single CSS rule.", "properties": { - "add": "The **`add()`** method of the\n[ContentIndex] interface registers an item with the [content index](/en-US/docs/Web/API/Content_Index_API).", - "delete": "The **`delete()`** method of the\n[ContentIndex] interface unregisters an item from the currently indexed\ncontent.\n\n> **Note:** Calling `delete()` only affects the index. It does not delete anything\n> from the [Cache].", - "getall": "The **`getAll()`** method of the\n[ContentIndex] interface returns a `Promise` that resolves with\nan iterable list of content index entries." + "media": "The read-only **`media`** property of the\n[CSSMediaRule] interface [MediaList] represents the intended\ndestination medium for style information." } }, - "contentindexevent": { - "docs": "The **`ContentIndexEvent`** interface of the [content index](/en-US/docs/Web/API/Content_Index_API) defines the object used to represent the [ServiceWorkerGlobalScope.contentdelete_event] event.\n\nThis event is sent to the [global scope](/en-US/docs/Web/API/ServiceWorkerGlobalScope) of a [ServiceWorker]. It contains the id of the indexed content to be removed.\n\nThe [ServiceWorkerGlobalScope.contentdelete_event] event is only fired when the deletion happens due to interaction with the browser's built-in user interface. It is not fired when the [ContentIndex.delete] method is called.", + "CSSNamespaceRule": { + "docs": "The **`CSSNamespaceRule`** interface describes an object representing a single CSS [at-rule](/en-US/docs/Web/CSS/At-rule).", "properties": { - "id": "The read-only **`id`** property of the\n[ContentIndexEvent] interface is a `String` which identifies\nthe deleted content index via its `id`." + "namespaceuri": "The read-only **`namespaceURI`** property of the [CSSNamespaceRule] returns a string containing the text of the URI of the given namespace.", + "prefix": "The read-only **`prefix`** property of the [CSSNamespaceRule] returns a string with the name of the prefix associated to this namespace. If there is no such prefix, it returns an empty string." } }, - "contentvisibilityautostatechangeevent": { - "docs": "The **`ContentVisibilityAutoStateChangeEvent`** interface is the event object for the [element/contentvisibilityautostatechange_event] event, which fires on any element with set on it when it starts or stops being [relevant to the user](/en-US/docs/Web/CSS/CSS_containment#relevant_to_the_user) and [skipping its contents](/en-US/docs/Web/CSS/CSS_containment#skips_its_contents).\n\nWhile the element is not relevant (between the start and end events), the user agent skips an element's rendering, including layout and painting.\nThis can significantly improve page rendering speed.\nThe [element/contentvisibilityautostatechange_event] event provides a way for an app's code to also start or stop rendering processes (e.g. drawing on a `canvas`) when they are not needed, thereby conserving processing power.\n\nNote that even when hidden from view, element contents will remain semantically relevant (e.g. to assistive technology users), so this signal should not be used to skip significant semantic DOM updates.", + "CSSNumericArray": { + "docs": "The **`CSSNumericArray`** interface of the contains a list of [CSSNumericValue] objects.", "properties": { - "skipped": "The `skipped` read-only property of the [ContentVisibilityAutoStateChangeEvent] interface returns `true` if the user agent [skips the element's contents](/en-US/docs/Web/CSS/CSS_containment#skips_its_contents), or `false` otherwise." + "length": "The read-only **`length`** property of the\n[CSSNumericArray] interface returns the number of\n[CSSNumericValue] objects in the list." } }, - "convolvernode": { - "docs": "The `ConvolverNode` interface is an [AudioNode] that performs a Linear Convolution on a given [AudioBuffer], often used to achieve a reverb effect. A `ConvolverNode` always has exactly one input and one output.\n\n> **Note:** For more information on the theory behind Linear Convolution, see the [Convolution article on Wikipedia](https://en.wikipedia.org/wiki/Convolution).\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Number of inputs1
Number of outputs1
Channel count mode\"clamped-max\"
Channel count1, 2, or 4
Channel interpretation\"speakers\"
", + "CSSNumericValue": { + "docs": "The **`CSSNumericValue`** interface of the [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Object_Model#css_typed_object_model) represents operations that all numeric values can perform.", "properties": { - "buffer": "The **`buffer`** property of the [ConvolverNode] interface represents a mono, stereo, or 4-channel [AudioBuffer] containing the (possibly multichannel) impulse response used by the `ConvolverNode` to create the reverb effect.\n\nThis is normally a simple recording of as-close-to-an-impulse as can be found in the space you want to model. For example, if you want to model the reverb in your bathroom, you might set up a microphone near the door to record the sound of a balloon pop or synthesized impulse from the sink. That audio recording could then be used as the buffer.\n\nThis audio buffer must have the same sample-rate as the `AudioContext` or an exception will be thrown. At the time when this attribute is set, the buffer and the state of the attribute will be used to configure the `ConvolverNode` with this impulse response having the given normalization. The initial value of this attribute is `null`.", - "normalize": "The `normalize` property of the [ConvolverNode] interface\nis a boolean that controls whether the impulse response from the buffer will be\nscaled by an equal-power normalization when the `buffer` attribute is set,\nor not.\n\nIts default value is `true` in order to achieve a more uniform output\nlevel from the convolver, when loaded with diverse impulse responses. If normalize is\nset to `false`, then the convolution will be rendered with no\npre-processing/scaling of the impulse response. Changes to this value do not take\neffect until the next time the `buffer` attribute is set." + "add": "The **`add()`** method of the\n[CSSNumericValue] interface adds a supplied number to the\n`CSSNumericValue`.", + "div": "The **`div()`** method of the\n[CSSNumericValue] interface divides the `CSSNumericValue` by the\nsupplied value.", + "equals": "The **`equals()`** method of the\n[CSSNumericValue] interface returns a boolean indicating whether the passed\nvalue are strictly equal. To return a value of `true`, all passed values must\nbe of the same type and value and must be in the same order. This allows structural\nequality to be tested quickly.", + "max": "The **`max()`** method of the\n[CSSNumericValue] interface returns the highest value from among the values\npassed. The passed values must be of the same type.", + "min": "The **`min()`** method of the\n[CSSNumericValue] interface returns the lowest value from among those\nvalues passed. The passed values must be of the same type.", + "mul": "The **`mul()`** method of the\n[CSSNumericValue] interface multiplies the `CSSNumericValue` by\nthe supplied value.", + "parse_static": "The **`parse()`** static method of the\n[CSSNumericValue] interface converts a value string into an object whose\nmembers are value and the units.", + "sub": "The **`sub()`** method of the\n[CSSNumericValue] interface subtracts a supplied number from the\n`CSSNumericValue`.", + "to": "The **`to()`** method of the\n[CSSNumericValue] interface converts a numeric value from one unit to\nanother.", + "tosum": "The **`toSum()`** method of the\n[CSSNumericValue] interface converts the object's value to a\n[CSSMathSum] object to values of the specified unit.", + "type": "The **`type()`** method of the\n[CSSNumericValue] interface returns the type of\n`CSSNumericValue`, one of `angle`, `flex`,\n`frequency`, `length`, `resolution`,\n`percent`, `percentHint`, or `time`." } }, - "cookiechangeevent": { - "docs": "The **`CookieChangeEvent`** interface of the [Cookie Store API] is the event type of the [CookieStore/change_event] event fired at a [CookieStore] when any cookie changes occur. A cookie change consists of a cookie and a type (either \"changed\" or \"deleted\").\n\nCookie changes that will cause the `CookieChangeEvent` to be dispatched are:\n\n- A cookie is newly created and not immediately removed. In this case `type` is \"changed\".\n- A cookie is newly created and immediately removed. In this case `type` is \"deleted\".\n- A cookie is removed. In this case `type` is \"deleted\".\n\n> **Note:** A cookie that is replaced due to the insertion of another cookie with the same name, domain, and path, is ignored and does not trigger a change event.", + "CSSPageRule": { + "docs": "**`CSSPageRule`** represents a single CSS rule.", "properties": { - "changed": "The **`changed`** read-only property of the [CookieChangeEvent] interface returns an array of the cookies that have been changed.", - "deleted": "The **`deleted`** read-only property of the [CookieChangeEvent] interface returns an array of the cookies that have been deleted by the given `CookieChangeEvent` instance." + "selectortext": "The **`selectorText`** property of the [CSSPageRule] interface gets and sets the selectors associated with the `CSSPageRule`.", + "style": "The **`style`** read-only property of the [CSSPageRule] interface returns a [CSSStyleDeclaration] object. This represents an object that is a [CSS declaration block](/en-US/docs/Web/API/CSS_Object_Model/CSS_Declaration_Block), and exposes style information and various style-related methods and properties." } }, - "cookiestore": { - "docs": "The **`CookieStore`** interface of the [Cookie Store API] provides methods for getting and setting cookies asynchronously from either a page or a service worker.\n\nThe `CookieStore` is accessed via attributes in the global scope in a [Window] or [ServiceWorkerGlobalScope] context. Therefore there is no constructor.", + "CSSPerspective": { + "docs": "The **`CSSPerspective`** interface of the represents the [perspective()](/en-US/docs/Web/CSS/transform-function/perspective) value of the individual `transform` property in CSS. It inherits properties and methods from its parent [CSSTransformValue].", "properties": { - "change_event": "A `change` event is fired at a [CookieStore] object when a change is made to any cookie.", - "delete": "The **`delete()`** method of the [CookieStore] interface deletes a cookie with the given name or options object. The `delete()` method expires the cookie by changing the date to one in the past.", - "get": "The **`get()`** method of the [CookieStore] interface returns a single cookie with the given name or options object. The method will return the first matching cookie for the passed parameters.", - "getall": "The **`getAll()`** method of the [CookieStore] interface returns a list of cookies that match the name or options passed to it. Passing no parameters will return all cookies for the current context.", - "set": "The **`set()`** method of the [CookieStore] interface sets a cookie with the given name and value or options object." + "length": "The **`length`** property of the\n[CSSPerspective] interface sets the distance from z=0.\n\nIt is used to apply a perspective transform to the element and its content. If the\nvalue is 0 or a negative number, no perspective transform is applied." } }, - "cookiestoremanager": { - "docs": "The **`CookieStoreManager`** interface of the [Cookie Store API] allows service workers to subscribe to cookie change events. Call [CookieStoreManager.subscribe] on a particular service worker registration to receive change events.\n\nA `CookieStoreManager` has an associated [ServiceWorkerRegistration]. Each service worker registration has a cookie change subscription list, which is a list of cookie change subscriptions each containing a name and URL. The methods in this interface allow the service worker to add and remove subscriptions from this list, and to get a list of all subscriptions.\n\nTo get a `CookieStoreManager`, call [ServiceWorkerRegistration.cookies].", + "CSSPositionValue": { + "docs": "The **`CSSPositionValue`** interface of the [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Object_Model#css_typed_object_model) represents values for properties that take a position, for example .", "properties": { - "getsubscriptions": "The **`getSubscriptions()`** method of the [CookieStoreManager] interface returns a list of all the cookie change subscriptions for this [ServiceWorkerRegistration].", - "subscribe": "The **`subscribe()`** method of the [CookieStoreManager] interface subscribes a [ServiceWorkerRegistration] to cookie change events.", - "unsubscribe": "The **`unsubscribe()`** method of the [CookieStoreManager] interface stops the [ServiceWorkerRegistration] from receiving previously subscribed events." + "x": "The **`x`** property of the\n[CSSPositionValue] interface returns the item's position along the web\npage's horizontal axis.", + "y": "The **`y`** property of the\n[CSSPositionValue] interface returns the item's position along the\nvertical axis." } }, - "countqueuingstrategy": { - "docs": "The **`CountQueuingStrategy`** interface of the [Streams API](/en-US/docs/Web/API/Streams_API) provides a built-in chunk counting queuing strategy that can be used when constructing streams.", + "CSSPrimitiveValue": { + "docs": "The **`CSSPrimitiveValue`** interface derives from the [CSSValue] interface and represents the current computed value of a CSS property.\n\n> **Note:** This interface was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.\n\nThis interface represents a single CSS value. It may be used to determine the value of a specific style property currently set in a block or to set a specific style property explicitly within the block. An instance of this interface might be obtained from the [CSSStyleDeclaration.getPropertyCSSValue] method of the [CSSStyleDeclaration] interface. A `CSSPrimitiveValue` object only occurs in a context of a CSS property.\n\nConversions are allowed between absolute values (from millimeters to centimeters, from degrees to radians, and so on) but not between relative values. (For example, a pixel value cannot be converted to a centimeter value.) Percentage values can't be converted since they are relative to the parent value (or another property value). There is one exception for color percentage values: since a color percentage value is relative to the range 0-255, a color percentage value can be converted to a number (see also the [RGBColor] interface).", "properties": { - "highwatermark": "The read-only **`CountQueuingStrategy.highWaterMark`** property returns the total number of chunks that can be contained in the internal queue before backpressure is applied.", - "size": "The **`size()`** method of the\n[CountQueuingStrategy] interface always returns `1`, so that the\ntotal queue size is a count of the number of chunks in the queue." + "getcountervalue": "The **`getCounterValue()`** method of the\n[CSSPrimitiveValue] interface is used to get the [counter](/en-US/docs/Web/CSS/CSS_counter_styles/Using_CSS_counters)\nvalue. If this CSS value doesn't contain a counter value, a [DOMException]\nis raised. Modification to the corresponding style property can be achieved using the\n[Counter] interface.\n\n> **Note:** This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.", + "getfloatvalue": "The **`getFloatValue()`** method of the\n[CSSPrimitiveValue] interface is used to get a float value in a specified\nunit. If this CSS value doesn't contain a float value or can't be converted into the\nspecified unit, a [DOMException] is raised.\n\n> **Note:** This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.", + "getrectvalue": "The **`getRectValue()`** method of the\n[CSSPrimitiveValue] interface is used to get a rect value. If this CSS\nvalue doesn't contain a rect value, a [DOMException] is raised.\nModification to the corresponding style property can be achieved using the\n[Rect] interface.\n\n> **Note:** This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.", + "getrgbcolorvalue": "The **`getRGBColorValue()`** method of the\n[CSSPrimitiveValue] interface is used to get an RGB color value. If this\nCSS value doesn't contain a RGB color value, a [DOMException] is raised.\nModification to the corresponding style property can be achieved using the\n[RGBColor] interface.\n\n> **Note:** This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.", + "getstringvalue": "The **`getStringValue()`** method of the\n[CSSPrimitiveValue] interface is used to get a string value. If this CSS\nvalue doesn't contain a string value, a [DOMException] is raised.\n\n> **Note:** This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.", + "primitivetype": "The **`primitiveType`** read-only property of the\n[CSSPrimitiveValue] interface represents the type of a CSS value.\n\n> **Note:** This property was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.", + "setfloatvalue": "The **`setFloatValue()`** method of the\n[CSSPrimitiveValue] interface is used to set a float value. If the property\nattached to this value can't accept the specified unit or the float value, the value\nwill be unchanged and a [DOMException] will be raised.\n\n> **Note:** This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.", + "setstringvalue": "The **`setStringValue()`** method of the\n[CSSPrimitiveValue] interface is used to set a string value. If the\nproperty attached to this value can't accept the specified unit or the string value, the\nvalue will be unchanged and a [DOMException] will be raised.\n\n> **Note:** This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do\n> not implement it.\n>\n> To achieve your purpose, you can use:\n>\n> - the untyped [CSS Object Model](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or\n> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental." } }, - "credential": { - "docs": "The **`Credential`** interface of the [Credential Management API](/en-US/docs/Web/API/Credential_Management_API) provides information about an entity (usually a user) normally as a prerequisite to a trust decision.\n\n`Credential` objects may be of the following types:\n\n- [FederatedCredential]\n- [IdentityCredential]\n- [PasswordCredential]\n- [PublicKeyCredential]\n- [OTPCredential]", + "CSSPropertyRule": { + "docs": "The **`CSSPropertyRule`** interface of the [CSS Properties and Values API](/en-US/docs/Web/API/CSS_Properties_and_Values_API) represents a single CSS rule.", "properties": { - "id": "The **`id`** read-only property of the [Credential] interface returns a string containing the credential's identifier. This might be a GUID, username, or email address, or some other value, depending on the type of credential.", - "type": "The **`type`** read-only property of the [Credential] interface returns a string containing the credential's type. Valid values are `password`, `federated`, `public-key`, `identity` and `otp`." + "inherits": "The read-only **`inherits`** property of the [CSSPropertyRule] interface returns the inherit flag of the custom property registration represented by the rule, a boolean describing whether or not the property inherits by default.", + "initialvalue": "The read-only **`initialValue`** nullable property of the [CSSPropertyRule] interface returns the initial value of the custom property registration represented by the rule, controlling the property's initial value.", + "name": "The read-only **`name`** property of the [CSSPropertyRule] interface represents the property name, this being the serialization of the name given to the custom property in the rule's prelude.", + "syntax": "The read-only **`syntax`** property of the [CSSPropertyRule] interface returns the literal syntax of the custom property registration represented by the rule, controlling how the property's value is parsed at computed-value time." } }, - "credentialscontainer": { - "docs": "The **`CredentialsContainer`** interface of the [Credential Management API](/en-US/docs/Web/API/Credential_Management_API) exposes methods to request credentials and notify the user agent when events such as successful sign in or sign out happen. This interface is accessible from [Navigator.credentials].", + "CSSPseudoElement": { + "docs": "The **`CSSPseudoElement`** interface represents a pseudo-element that may be the target of an event or animated using the [Web Animations API]. Instances of this interface may be obtained by calling [Element.pseudo].", "properties": { - "create": "The **`create()`** method of the [CredentialsContainer] interface returns a `Promise` that resolves with a new credential instance based on the provided options, the information from which can then be stored and later used to authenticate users via [CredentialsContainer.get].\n\nThis is used by multiple different credential-related APIs with significantly different purposes:\n\n- The [Credential Management API](/en-US/docs/Web/API/Credential_Management_API) uses `create()` to create basic federated credentials or username/password credentials.\n- The [Web Authentication API](/en-US/docs/Web/API/Web_Authentication_API) uses `create()` to create public key credentials (based on asymmetric cryptography).\n\nThe below reference page starts with a syntax section that explains the general method call structure and parameters that apply to all the different APIs. After that, it is split into separate sections providing parameters, return values, and examples specific to each API.\n\n> **Note:** This method is restricted to top-level (i.e., a document running directly inside a browser tab, and not embedded inside another document). Calls to it from within an `