feat: document fullscreenElement and visibilityState bindings (#8507)

elements/index.d.ts

@@ -1078,6 +1078,11 @@ export interface SvelteMediaTimeRange {
 	end: number;
 }
 
+export interface SvelteDocumentAttributes extends HTMLAttributes<Document> {
+	readonly 'bind:fullscreenElement'?: Document['fullscreenElement'] | undefined | null;
+	readonly 'bind:visibilityState'?: Document['visibilityState'] | undefined | null;
+}
+
 export interface SvelteWindowAttributes extends HTMLAttributes<Window> {
 	readonly 'bind:innerWidth'?: Window['innerWidth'] | undefined | null;
 	readonly 'bind:innerHeight'?: Window['innerHeight'] | undefined | null;
@@ -1592,7 +1597,7 @@ export interface SvelteHTMLElements {
 
 	// Svelte specific
 	'svelte:window': SvelteWindowAttributes;
-	'svelte:document': HTMLAttributes<Document>;
+	'svelte:document': SvelteDocumentAttributes;
 	'svelte:body': HTMLAttributes<HTMLElement>;
 	'svelte:fragment': { slot?: string };
 	'svelte:options': { [name: string]: any };

site/content/docs/03-template-syntax.md

@@ -1759,6 +1759,9 @@ All except `scrollX` and `scrollY` are readonly.
 ```sv
 <svelte:document on:event={handler}/>
 ```
+```sv
+<svelte:document bind:prop={value}/>
+```
 
 ---
 
@@ -1773,6 +1776,15 @@ As with `<svelte:window>`, this element may only appear the top level of your co
 />
 ```
 
+---
+
+You can also bind to the following properties:
+
+* `fullscreenElement`
+* `visibilityState`
+
+All are readonly.
+
 ### `<svelte:body>`
 
 ```sv

src/compiler/compile/nodes/Binding.ts

@@ -9,6 +9,7 @@ import { TemplateNode } from '../../interfaces';
 import Element from './Element';
 import InlineComponent from './InlineComponent';
 import Window from './Window';
+import Document from './Document';
 import { clone } from '../../utils/clone';
 import compiler_errors from '../compiler_errors';
 import compiler_warnings from '../compiler_warnings';
@@ -36,7 +37,7 @@ export default class Binding extends Node {
 	is_contextual: boolean;
 	is_readonly: boolean;
 
-	constructor(component: Component, parent: Element | InlineComponent | Window, scope: TemplateScope, info: TemplateNode) {
+	constructor(component: Component, parent: Element | InlineComponent | Window | Document, scope: TemplateScope, info: TemplateNode) {
 		super(component, parent, scope, info);
 
 		if (info.expression.type !== 'Identifier' && info.expression.type !== 'MemberExpression') {

src/compiler/compile/nodes/Document.ts

@@ -1,14 +1,24 @@
 import Node from './shared/Node';
+import Binding from './Binding';
 import EventHandler from './EventHandler';
+import fuzzymatch from '../../utils/fuzzymatch';
 import Action from './Action';
 import Component from '../Component';
+import list from '../../utils/list';
 import TemplateScope from './shared/TemplateScope';
 import { Element } from '../../interfaces';
 import compiler_warnings from '../compiler_warnings';
+import compiler_errors from '../compiler_errors';
+
+const valid_bindings = [
+	'fullscreenElement',
+	'visibilityState'
+];
 
 export default class Document extends Node {
 	type: 'Document';
 	handlers: EventHandler[] = [];
+	bindings: Binding[] = [];
 	actions: Action[] = [];
 
 	constructor(component: Component, parent: Node, scope: TemplateScope, info: Element) {
@@ -17,6 +27,17 @@ export default class Document extends Node {
 		info.attributes.forEach((node) => {
 			if (node.type === 'EventHandler') {
 				this.handlers.push(new EventHandler(component, this, scope, node));
+			} else if (node.type === 'Binding') {
+				if (!~valid_bindings.indexOf(node.name)) {
+					const match = fuzzymatch(node.name, valid_bindings);
+					if (match) {
+						return component.error(node, compiler_errors.invalid_binding_on(node.name, '<svelte:document>', ` (did you mean '${match}'?)`));
+					} else {
+						return component.error(node, compiler_errors.invalid_binding_on(node.name, '<svelte:document>', ` — valid bindings are ${list(valid_bindings)}`));
+					}
+				}
+
+				this.bindings.push(new Binding(component, this, scope, node));
 			} else if (node.type === 'Action') {
 				this.actions.push(new Action(component, this, scope, node));
 			} else {

src/compiler/compile/render_dom/wrappers/Document.ts

@@ -1,6 +1,6 @@
 import Block from '../Block';
 import Wrapper from './shared/Wrapper';
-import { x } from 'code-red';
+import { b, x } from 'code-red';
 import Document from '../../nodes/Document';
 import { Identifier } from 'estree';
 import EventHandler from './Element/EventHandler';
@@ -9,6 +9,16 @@ import { TemplateNode } from '../../../interfaces';
 import Renderer from '../Renderer';
 import add_actions from './shared/add_actions';
 
+const associated_events = {
+	fullscreenElement: ['fullscreenchange'],
+	visibilityState: ['visibilitychange']
+};
+
+const readonly = new Set([
+	'fullscreenElement',
+	'visibilityState'
+]);
+
 export default class DocumentWrapper extends Wrapper {
 	node: Document;
 	handlers: EventHandler[];
@@ -19,7 +29,66 @@ export default class DocumentWrapper extends Wrapper {
 	}
 
 	render(block: Block, _parent_node: Identifier, _parent_nodes: Identifier) {
+		const { renderer } = this;
+		const { component } = renderer;
+
+		const events: Record<string, Array<{ name: string; value: string }>> = {};
+		const bindings: Record<string, string> = {};
+
 		add_event_handlers(block, x`@_document`, this.handlers);
 		add_actions(block, x`@_document`, this.node.actions);
+
+		this.node.bindings.forEach(binding => {
+			// TODO: what if it's a MemberExpression?
+			const binding_name = (binding.expression.node as Identifier).name;
+
+			// in dev mode, throw if read-only values are written to
+			if (readonly.has(binding.name)) {
+				renderer.readonly.add(binding_name);
+			}
+
+			bindings[binding.name] = binding_name;
+
+			const binding_events = associated_events[binding.name];
+			const property = binding.name;
+
+			binding_events.forEach(associated_event => {
+				if (!events[associated_event]) events[associated_event] = [];
+				events[associated_event].push({
+					name: binding_name,
+					value: property
+				});
+			});
+		});
+
+		Object.keys(events).forEach(event => {
+			const id = block.get_unique_name(`ondocument${event}`);
+			const props = events[event];
+
+			renderer.add_to_context(id.name);
+			const fn = renderer.reference(id.name);
+
+			props.forEach(prop => {
+				renderer.meta_bindings.push(
+					b`this._state.${prop.name} = @_document.${prop.value};`
+				);
+			});
+
+			block.event_listeners.push(x`
+				@listen(@_document, "${event}", ${fn})
+			`);
+
+			component.partly_hoisted.push(b`
+				function ${id}() {
+					${props.map(prop => renderer.invalidate(prop.name, x`${prop.name} = @_document.${prop.value}`))}
+				}
+			`);
+
+			block.chunks.init.push(b`
+				@add_render_callback(${fn});
+			`);
+
+			component.has_reactive_assignments = true;
+		});
 	}
 }

test/runtime/samples/document-binding-fullscreen/_config.js

@@ -0,0 +1,31 @@
+export default {
+	before_test() {
+		Object.defineProperties(window.document, {
+			fullscreenElement: {
+				value: null,
+				configurable: true
+			}
+		});
+	},
+
+  // copied from window-binding
+  // there's some kind of weird bug with this test... it compiles with the wrong require.extensions hook for some bizarre reason
+	skip_if_ssr: true, 
+
+	async test({ assert, target, window, component }) {
+		const event = new window.Event('fullscreenchange');
+
+    const div = target.querySelector('div');
+
+		Object.defineProperties(window.document, {
+			fullscreenElement: {
+				value: div,
+				configurable: true
+			}
+		});
+
+		window.document.dispatchEvent(event);
+
+		assert.equal(component.fullscreen, div);
+	}
+};

test/runtime/samples/document-binding-fullscreen/main.svelte

@@ -0,0 +1,7 @@
+<script>
+	export let fullscreen;
+</script>
+
+<svelte:document bind:fullscreenElement={fullscreen}/>
+
+<div />