Expand description
Raw API bindings for Web APIs
This is a procedurally generated crate from browser WebIDL which provides a binding to all APIs that browsers provide on the web.
This crate by default contains very little when compiled as almost all of
its exposed APIs are gated by Cargo features. The exhaustive list of
features can be found in crates/web-sys/Cargo.toml, but the rule of thumb
for web-sys is that each type has its own cargo feature (named after the
type). Using an API requires enabling the features for all types used in the
API, and APIs should mention in the documentation what features they
require.
Re-exports§
pub use js_sys;pub use wasm_bindgen;
Modules§
Structs§
- Abort
Controller - The
AbortControllerclass. - Abort
Signal - The
AbortSignalclass. - Abstract
Range - The
AbstractRangeclass. - AddEvent
Listener Options - The
AddEventListenerOptionsdictionary. - Animation
- The
Animationclass. - Animation
Effect - The
AnimationEffectclass. - Animation
Event - The
AnimationEventclass. - Animation
Timeline - The
AnimationTimelineclass. - Attr
- The
Attrclass. - Before
Unload Event - The
BeforeUnloadEventclass. - Blob
- The
Blobclass. - Blob
Property Bag - The
BlobPropertyBagdictionary. - Cache
- The
Cacheclass. - Cache
Query Options - The
CacheQueryOptionsdictionary. - Cache
Storage - The
CacheStorageclass. - Canvas
Gradient - The
CanvasGradientclass. - Canvas
Pattern - The
CanvasPatternclass. - Canvas
Rendering Context2d - The
CanvasRenderingContext2dclass. - Character
Data - The
CharacterDataclass. - Client
- The
Clientclass. - Clients
- The
Clientsclass. - Clipboard
- The
Clipboardclass. - Clipboard
Event - The
ClipboardEventclass. - Clipboard
Item - The
ClipboardItemclass. - Close
Event - The
CloseEventclass. - Close
Event Init - The
CloseEventInitdictionary. - Comment
- The
Commentclass. - Composition
Event - The
CompositionEventclass. - Crypto
- The
Cryptoclass. - Crypto
Key - The
CryptoKeyclass. - CssRule
- The
CssRuleclass. - CssRule
List - The
CssRuleListclass. - CssStyle
Declaration - The
CssStyleDeclarationclass. - CssStyle
Sheet - The
CssStyleSheetclass. - Custom
Event - The
CustomEventclass. - Custom
Event Init - The
CustomEventInitdictionary. - Data
Transfer - The
DataTransferclass. - Data
Transfer Item - The
DataTransferItemclass. - Data
Transfer Item List - The
DataTransferItemListclass. - Dedicated
Worker Global Scope - The
DedicatedWorkerGlobalScopeclass. - Document
- The
Documentclass. - Document
Fragment - The
DocumentFragmentclass. - Document
Type - The
DocumentTypeclass. - DomException
- The
DomExceptionclass. - DomImplementation
- The
DomImplementationclass. - DomParser
- The
DomParserclass. - DomRect
- The
DomRectclass. - DomRect
Read Only - The
DomRectReadOnlyclass. - DomString
List - The
DomStringListclass. - DomString
Map - The
DomStringMapclass. - DomToken
List - The
DomTokenListclass. - Drag
Event - The
DragEventclass. - Element
- The
Elementclass. - Error
Event - The
ErrorEventclass. - Event
- The
Eventclass. - Event
Init - The
EventInitdictionary. - Event
Listener - The
EventListenerdictionary. - Event
Listener Options - The
EventListenerOptionsdictionary. - Event
Source - The
EventSourceclass. - Event
Target - The
EventTargetclass. - Extendable
Event - The
ExtendableEventclass. - Extendable
Message Event - The
ExtendableMessageEventclass. - Fetch
Event - The
FetchEventclass. - File
- The
Fileclass. - File
List - The
FileListclass. - File
Property Bag - The
FilePropertyBagdictionary. - File
Reader - The
FileReaderclass. - Focus
Event - The
FocusEventclass. - Focus
Options - The
FocusOptionsdictionary. - Form
Data - The
FormDataclass. - Geolocation
- The
Geolocationclass. - Hash
Change Event - The
HashChangeEventclass. - Headers
- The
Headersclass. - History
- The
Historyclass. - Html
Anchor Element - The
HtmlAnchorElementclass. - Html
Audio Element - The
HtmlAudioElementclass. - Html
Body Element - The
HtmlBodyElementclass. - Html
BrElement - The
HtmlBrElementclass. - Html
Button Element - The
HtmlButtonElementclass. - Html
Canvas Element - The
HtmlCanvasElementclass. - Html
Collection - The
HtmlCollectionclass. - Html
DivElement - The
HtmlDivElementclass. - Html
Document - The
HtmlDocumentclass. - Html
Element - The
HtmlElementclass. - Html
Form Element - The
HtmlFormElementclass. - Html
Head Element - The
HtmlHeadElementclass. - Html
Image Element - The
HtmlImageElementclass. - Html
Input Element - The
HtmlInputElementclass. - Html
Label Element - The
HtmlLabelElementclass. - Html
Link Element - The
HtmlLinkElementclass. - Html
Media Element - The
HtmlMediaElementclass. - Html
Meta Element - The
HtmlMetaElementclass. - Html
Option Element - The
HtmlOptionElementclass. - Html
Options Collection - The
HtmlOptionsCollectionclass. - Html
Paragraph Element - The
HtmlParagraphElementclass. - Html
Script Element - The
HtmlScriptElementclass. - Html
Select Element - The
HtmlSelectElementclass. - Html
Span Element - The
HtmlSpanElementclass. - Html
Style Element - The
HtmlStyleElementclass. - Html
Table Cell Element - The
HtmlTableCellElementclass. - Html
Table Element - The
HtmlTableElementclass. - Html
Table RowElement - The
HtmlTableRowElementclass. - Html
Template Element - The
HtmlTemplateElementclass. - Html
Text Area Element - The
HtmlTextAreaElementclass. - Html
Video Element - The
HtmlVideoElementclass. - IdbCursor
- The
IdbCursorclass. - IdbCursor
With Value - The
IdbCursorWithValueclass. - IdbDatabase
- The
IdbDatabaseclass. - IdbFactory
- The
IdbFactoryclass. - IdbIndex
- The
IdbIndexclass. - IdbKey
Range - The
IdbKeyRangeclass. - IdbObject
Store - The
IdbObjectStoreclass. - IdbOpen
DbRequest - The
IdbOpenDbRequestclass. - IdbRequest
- The
IdbRequestclass. - IdbTransaction
- The
IdbTransactionclass. - IdbVersion
Change Event - The
IdbVersionChangeEventclass. - Image
Bitmap - The
ImageBitmapclass. - Image
Bitmap Options - The
ImageBitmapOptionsdictionary. - Image
Data - The
ImageDataclass. - Image
Encode Options - The
ImageEncodeOptionsdictionary. - Input
Event - The
InputEventclass. - Intersection
Observer - The
IntersectionObserverclass. - Intersection
Observer Entry - The
IntersectionObserverEntryclass. - Intersection
Observer Init - The
IntersectionObserverInitdictionary. - Keyboard
Event - The
KeyboardEventclass. - Keyboard
Event Init - The
KeyboardEventInitdictionary. - Keyframe
Effect - The
KeyframeEffectclass. - Location
- The
Locationclass. - Media
Device Info - The
MediaDeviceInfoclass. - Media
Devices - The
MediaDevicesclass. - Media
Error - The
MediaErrorclass. - Media
List - The
MediaListclass. - Media
Query List - The
MediaQueryListclass. - Media
Query List Event - The
MediaQueryListEventclass. - Media
Stream - The
MediaStreamclass. - Media
Stream Constraints - The
MediaStreamConstraintsdictionary. - Media
Stream Track - The
MediaStreamTrackclass. - Message
Channel - The
MessageChannelclass. - Message
Event - The
MessageEventclass. - Message
Event Init - The
MessageEventInitdictionary. - Message
Port - The
MessagePortclass. - Mouse
Event - The
MouseEventclass. - Mouse
Event Init - The
MouseEventInitdictionary. - Mutation
Observer - The
MutationObserverclass. - Mutation
Observer Init - The
MutationObserverInitdictionary. - Mutation
Record - The
MutationRecordclass. - Named
Node Map - The
NamedNodeMapclass. - Navigator
- The
Navigatorclass. - Node
- The
Nodeclass. - Node
Filter - The
NodeFilterdictionary. - Node
Iterator - The
NodeIteratorclass. - Node
List - The
NodeListclass. - Notification
- The
Notificationclass. - Notification
Options - The
NotificationOptionsdictionary. - Observer
Callback - The
ObserverCallbackdictionary. - Offscreen
Canvas - The
OffscreenCanvasclass. - Offscreen
Canvas Rendering Context2d - The
OffscreenCanvasRenderingContext2dclass. - Page
Transition Event - The
PageTransitionEventclass. - Path2d
- The
Path2dclass. - Performance
- The
Performanceclass. - Performance
Entry - The
PerformanceEntryclass. - Performance
Mark - The
PerformanceMarkclass. - Performance
Measure - The
PerformanceMeasureclass. - Performance
Navigation - The
PerformanceNavigationclass. - Performance
Observer - The
PerformanceObserverclass. - Performance
Observer Init - The
PerformanceObserverInitdictionary. - Performance
Resource Timing - The
PerformanceResourceTimingclass. - Performance
Timing - The
PerformanceTimingclass. - Permission
Status - The
PermissionStatusclass. - Permissions
- The
Permissionsclass. - Pointer
Event - The
PointerEventclass. - Pointer
Event Init - The
PointerEventInitdictionary. - PopState
Event - The
PopStateEventclass. - Position
- The
Positionclass. - Position
Error - The
PositionErrorclass. - Position
Options - The
PositionOptionsdictionary. - Processing
Instruction - The
ProcessingInstructionclass. - Progress
Event - The
ProgressEventclass. - Promise
Rejection Event - The
PromiseRejectionEventclass. - Queuing
Strategy - The
QueuingStrategydictionary. - Range
- The
Rangeclass. - Readable
Byte Stream Controller - The
ReadableByteStreamControllerclass. - Readable
Stream - The
ReadableStreamclass. - Readable
Stream Byob Reader - The
ReadableStreamByobReaderclass. - Readable
Stream Byob Request - The
ReadableStreamByobRequestclass. - Readable
Stream Default Controller - The
ReadableStreamDefaultControllerclass. - Readable
Stream Default Reader - The
ReadableStreamDefaultReaderclass. - Readable
Stream GetReader Options - The
ReadableStreamGetReaderOptionsdictionary. - Readable
Stream Read Result - The
ReadableStreamReadResultdictionary. - Readable
Writable Pair - The
ReadableWritablePairdictionary. - Request
- The
Requestclass. - Request
Init - The
RequestInitdictionary. - Resize
Observer - The
ResizeObserverclass. - Resize
Observer Entry - The
ResizeObserverEntryclass. - Resize
Observer Size - The
ResizeObserverSizeclass. - Response
- The
Responseclass. - Response
Init - The
ResponseInitdictionary. - Screen
- The
Screenclass. - Scroll
Into View Options - The
ScrollIntoViewOptionsdictionary. - Scroll
ToOptions - The
ScrollToOptionsdictionary. - Security
Policy Violation Event - The
SecurityPolicyViolationEventclass. - Selection
- The
Selectionclass. - Service
Worker - The
ServiceWorkerclass. - Service
Worker Container - The
ServiceWorkerContainerclass. - Service
Worker Global Scope - The
ServiceWorkerGlobalScopeclass. - Service
Worker Registration - The
ServiceWorkerRegistrationclass. - Shadow
Root - The
ShadowRootclass. - Shadow
Root Init - The
ShadowRootInitdictionary. - Shared
Worker - The
SharedWorkerclass. - Shared
Worker Global Scope - The
SharedWorkerGlobalScopeclass. - Storage
- The
Storageclass. - Storage
Estimate - The
StorageEstimatedictionary. - Storage
Event - The
StorageEventclass. - Storage
Manager - The
StorageManagerclass. - Stream
Pipe Options - The
StreamPipeOptionsdictionary. - Style
Sheet - The
StyleSheetclass. - Style
Sheet List - The
StyleSheetListclass. - Submit
Event - The
SubmitEventclass. - Subtle
Crypto - The
SubtleCryptoclass. - SvgElement
- The
SvgElementclass. - SvgGraphics
Element - The
SvgGraphicsElementclass. - Svgsvg
Element - The
SvgsvgElementclass. - Text
- The
Textclass. - Text
Decoder - The
TextDecoderclass. - Text
Encoder - The
TextEncoderclass. - Text
Metrics - The
TextMetricsclass. - Toggle
Event - The
ToggleEventclass. - Touch
- The
Touchclass. - Touch
Event - The
TouchEventclass. - Touch
Init - The
TouchInitdictionary. - Touch
List - The
TouchListclass. - Transform
Stream - The
TransformStreamclass. - Transform
Stream Default Controller - The
TransformStreamDefaultControllerclass. - Transformer
- The
Transformerdictionary. - Transition
Event - The
TransitionEventclass. - Tree
Walker - The
TreeWalkerclass. - UiEvent
- The
UiEventclass. - UiEvent
Init - The
UiEventInitdictionary. - Underlying
Sink - The
UnderlyingSinkdictionary. - Underlying
Source - The
UnderlyingSourcedictionary. - Url
- The
Urlclass. - UrlSearch
Params - The
UrlSearchParamsclass. - User
Activation - The
UserActivationclass. - Validity
State - The
ValidityStateclass. - Visual
Viewport - The
VisualViewportclass. - Wake
Lock - The
WakeLockclass. - Wake
Lock Sentinel - The
WakeLockSentinelclass. - WebGl2
Rendering Context - The
WebGl2RenderingContextclass. - WebGl
Active Info - The
WebGlActiveInfoclass. - WebGl
Buffer - The
WebGlBufferclass. - WebGl
Context Attributes - The
WebGlContextAttributesdictionary. - WebGl
Context Event - The
WebGlContextEventclass. - WebGl
Framebuffer - The
WebGlFramebufferclass. - WebGl
Program - The
WebGlProgramclass. - WebGl
Renderbuffer - The
WebGlRenderbufferclass. - WebGl
Rendering Context - The
WebGlRenderingContextclass. - WebGl
Shader - The
WebGlShaderclass. - WebGl
Texture - The
WebGlTextureclass. - WebGl
Uniform Location - The
WebGlUniformLocationclass. - WebSocket
- The
WebSocketclass. - Wheel
Event - The
WheelEventclass. - Window
- The
Windowclass. - Worker
- The
Workerclass. - Worker
Global Scope - The
WorkerGlobalScopeclass. - Worker
Location - The
WorkerLocationclass. - Worker
Navigator - The
WorkerNavigatorclass. - Worker
Options - The
WorkerOptionsdictionary. - Writable
Stream - The
WritableStreamclass. - Writable
Stream Default Controller - The
WritableStreamDefaultControllerclass. - Writable
Stream Default Writer - The
WritableStreamDefaultWriterclass. - XmlHttp
Request - The
XmlHttpRequestclass. - XmlHttp
Request Event Target - The
XmlHttpRequestEventTargetclass. - XmlSerializer
- The
XmlSerializerclass.
Enums§
- Binary
Type - The
BinaryTypeenum. - Canvas
Winding Rule - The
CanvasWindingRuleenum. - IdbCursor
Direction - The
IdbCursorDirectionenum. - IdbTransaction
Mode - The
IdbTransactionModeenum. - Media
Stream Track State - The
MediaStreamTrackStateenum. - Notification
Permission - The
NotificationPermissionenum. - Permission
State - The
PermissionStateenum. - Readable
Stream Reader Mode - The
ReadableStreamReaderModeenum. - Readable
Stream Type - The
ReadableStreamTypeenum. - Referrer
Policy - The
ReferrerPolicyenum. - Request
Cache - The
RequestCacheenum. - Request
Credentials - The
RequestCredentialsenum. - Request
Mode - The
RequestModeenum. - Request
Redirect - The
RequestRedirectenum. - Response
Type - The
ResponseTypeenum. - Scroll
Behavior - The
ScrollBehaviorenum. - Scroll
Logical Position - The
ScrollLogicalPositionenum. - Scroll
Restoration - The
ScrollRestorationenum. - Service
Worker State - The
ServiceWorkerStateenum. - Shadow
Root Mode - The
ShadowRootModeenum. - Visibility
State - The
VisibilityStateenum. - Worker
Type - The
WorkerTypeenum. - XmlHttp
Request Response Type - The
XmlHttpRequestResponseTypeenum.
Functions§
- window
- Getter for the
Windowobject