msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

tweak docs

Browse Source
pull/14660/head
Rich Harris 2 years ago
parent cb2efe6c65
commit 42b8d773ad
3 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File

2
documentation/docs/98-reference/21-svelte-reactivity-window.md
Unescape View File

@ -2,7 +2,7 @@
title: svelte/reactivity/window
---
This module exports reactive versions of various `window` properties, which you can use in components and [deriveds]($derived) and [effects]($effect) without using [`<svelte:window>`](svelte-window) bindings or manually creating your own event listeners.
This module exports reactive versions of various `window` values, each of which has a reactive `current` property that you can reference in reactive contexts (templates, [deriveds]($derived) and [effects]($effect)) without using [`<svelte:window>`](svelte-window) bindings or manually creating your own event listeners.
```svelte
<script>

20
packages/svelte/src/reactivity/window/index.js
Unescape View File

@ -5,7 +5,7 @@ import { get } from '../../internal/client/index.js';
import { set, source } from '../../internal/client/reactivity/sources.js';
/**
* `scrollX.current` is a reactive view of `window.scrollX`. On the server it is `undefined`
* `scrollX.current` is a reactive view of `window.scrollX`. On the server it is `undefined`.
*/
export const scrollX = new ReactiveValue(
BROWSER ? () => window.scrollX : () => undefined,
@ -13,7 +13,7 @@ export const scrollX = new ReactiveValue(
);
/**
* `scrollY.current` is a reactive view of `window.scrollY`. On the server it is `undefined`
* `scrollY.current` is a reactive view of `window.scrollY`. On the server it is `undefined`.
*/
export const scrollY = new ReactiveValue(
BROWSER ? () => window.scrollY : () => undefined,
@ -21,7 +21,7 @@ export const scrollY = new ReactiveValue(
);
/**
* `innerWidth.current` is a reactive view of `window.innerWidth`. On the server it is `undefined`
* `innerWidth.current` is a reactive view of `window.innerWidth`. On the server it is `undefined`.
*/
export const innerWidth = new ReactiveValue(
BROWSER ? () => window.innerWidth : () => undefined,
@ -29,7 +29,7 @@ export const innerWidth = new ReactiveValue(
);
/**
* `innerHeight.current` is a reactive view of `window.innerHeight`. On the server it is `undefined`
* `innerHeight.current` is a reactive view of `window.innerHeight`. On the server it is `undefined`.
*/
export const innerHeight = new ReactiveValue(
BROWSER ? () => window.innerHeight : () => undefined,
@ -37,7 +37,7 @@ export const innerHeight = new ReactiveValue(
);
/**
* `outerWidth.current` is a reactive view of `window.outerWidth`. On the server it is `undefined`
* `outerWidth.current` is a reactive view of `window.outerWidth`. On the server it is `undefined`.
*/
export const outerWidth = new ReactiveValue(
BROWSER ? () => window.outerWidth : () => undefined,
@ -45,7 +45,7 @@ export const outerWidth = new ReactiveValue(
);
/**
* `outerHeight.current` is a reactive view of `window.outerHeight`. On the server it is `undefined`
* `outerHeight.current` is a reactive view of `window.outerHeight`. On the server it is `undefined`.
*/
export const outerHeight = new ReactiveValue(
BROWSER ? () => window.outerHeight : () => undefined,
@ -53,7 +53,7 @@ export const outerHeight = new ReactiveValue(
);
/**
* `screenLeft.current` is a reactive view of `window.screenLeft`. On the server it is `undefined`
* `screenLeft.current` is a reactive view of `window.screenLeft`. On the server it is `undefined`.
*/
export const screenLeft = new ReactiveValue(
BROWSER ? () => window.screenLeft : () => undefined,
@ -75,7 +75,7 @@ export const screenLeft = new ReactiveValue(
);
/**
* `screenTop.current` is a reactive view of `window.screenTop`. On the server it is `undefined`
* `screenTop.current` is a reactive view of `window.screenTop`. On the server it is `undefined`.
*/
export const screenTop = new ReactiveValue(
BROWSER ? () => window.screenTop : () => undefined,
@ -97,7 +97,7 @@ export const screenTop = new ReactiveValue(
);
/**
* `online.current` is a reactive view of `navigator.onLine`. On the server it is `undefined`
* `online.current` is a reactive view of `navigator.onLine`. On the server it is `undefined`.
*/
export const online = new ReactiveValue(
BROWSER ? () => navigator.onLine : () => undefined,
@ -114,7 +114,7 @@ export const online = new ReactiveValue(
/**
* `devicePixelRatio.current` is a reactive view of `window.devicePixelRatio`. On the server it is `undefined`.
* Note that behaviour differs between browsers — on Chrome it will respond to the current zoom level,
* on Firefox and Safari it won't
* on Firefox and Safari it won't.
* @type {{ get current(): number }}
*/
export const devicePixelRatio = /* @__PURE__ */ new (class DevicePixelRatio {

20
packages/svelte/types/index.d.ts vendored
Unescape View File

@ -1964,45 +1964,45 @@ declare module 'svelte/reactivity' {
declare module 'svelte/reactivity/window' {
/**
* `scrollX.current` is a reactive view of `window.scrollX`. On the server it is `undefined`
* `scrollX.current` is a reactive view of `window.scrollX`. On the server it is `undefined`.
*/
export const scrollX: ReactiveValue<number | undefined>;
/**
* `scrollY.current` is a reactive view of `window.scrollY`. On the server it is `undefined`
* `scrollY.current` is a reactive view of `window.scrollY`. On the server it is `undefined`.
*/
export const scrollY: ReactiveValue<number | undefined>;
/**
* `innerWidth.current` is a reactive view of `window.innerWidth`. On the server it is `undefined`
* `innerWidth.current` is a reactive view of `window.innerWidth`. On the server it is `undefined`.
*/
export const innerWidth: ReactiveValue<number | undefined>;
/**
* `innerHeight.current` is a reactive view of `window.innerHeight`. On the server it is `undefined`
* `innerHeight.current` is a reactive view of `window.innerHeight`. On the server it is `undefined`.
*/
export const innerHeight: ReactiveValue<number | undefined>;
/**
* `outerWidth.current` is a reactive view of `window.outerWidth`. On the server it is `undefined`
* `outerWidth.current` is a reactive view of `window.outerWidth`. On the server it is `undefined`.
*/
export const outerWidth: ReactiveValue<number | undefined>;
/**
* `outerHeight.current` is a reactive view of `window.outerHeight`. On the server it is `undefined`
* `outerHeight.current` is a reactive view of `window.outerHeight`. On the server it is `undefined`.
*/
export const outerHeight: ReactiveValue<number | undefined>;
/**
* `screenLeft.current` is a reactive view of `window.screenLeft`. On the server it is `undefined`
* `screenLeft.current` is a reactive view of `window.screenLeft`. On the server it is `undefined`.
*/
export const screenLeft: ReactiveValue<number | undefined>;
/**
* `screenTop.current` is a reactive view of `window.screenTop`. On the server it is `undefined`
* `screenTop.current` is a reactive view of `window.screenTop`. On the server it is `undefined`.
*/
export const screenTop: ReactiveValue<number | undefined>;
/**
* `online.current` is a reactive view of `navigator.onLine`. On the server it is `undefined`
* `online.current` is a reactive view of `navigator.onLine`. On the server it is `undefined`.
*/
export const online: ReactiveValue<boolean | undefined>;
/**
* `devicePixelRatio.current` is a reactive view of `window.devicePixelRatio`. On the server it is `undefined`.
* Note that behaviour differs between browsers — on Chrome it will respond to the current zoom level,
* on Firefox and Safari it won't
* on Firefox and Safari it won't.
* */
export const devicePixelRatio: {
get current(): number;

Write Preview
Loading…
Cancel
Save