Zen Browser

https://github.com/zen-browser/desktop
Admin
Zen is a Firefox-based browser designed to significantly boost user productivity, offering a...
Tokens:6,476
Snippets:41
Trust Score:8.1
License:MPL-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Remote REST schema mapping configuration

Source: https://github.com/zen-browser/desktop/blob/dev/docs/live-folders-specs.md

Example mapping configuration for a remote REST API Live Folder. Specifies the endpoint URL and how to map response fields to folder item properties (items, id, title, url).

```json
{
  "type": "rest",
  "url": "https://api.example.com/posts",
  "mapping": {
    "items": "data.posts",
    "id": "id",
    "title": "headline",
    "url": "link"
  }
}
```

--------------------------------

### Draw red rectangle on canvas

Source: https://github.com/zen-browser/desktop/blob/dev/src/zen/tests/mochitests/shell/canvas.html

Draws a red rectangle on a 2D canvas context obtained from an element with id "c". Use when you need a minimal canvas drawing example.

```javascript
const ctx = document.getElementById("c").getContext("2d"); ctx.fillStyle = "red"; ctx.fillRect(0, 0, 200, 100);
```

--------------------------------

### Bundle new tab assets with ./mach npm run bundle

Source: https://github.com/zen-browser/desktop/blob/dev/src/browser/components/newtab/README.md

Run this command from the project root to bundle the new tab assets. Requires meow@9.0.0; other versions may not work.

```bash
./mach npm run bundle --prefix=browser/components/newtab
```

--------------------------------

### LiveFolderProvider interface with FolderItem and FolderMetadata

Source: https://github.com/zen-browser/desktop/blob/dev/docs/live-folders-specs.md

Defines the contract for live folder providers: fetchItems returns a promise of folder items, and getMetadata returns icon and label. Used as the abstract base for all live folder implementations.

```typescript
interface FolderItem {
  id: string;
  title: string;
  url: string;
}

interface FolderMetadata {
  icon: string;
  label: string;
}

interface LiveFolderProvider {
  fetchItems(): Promise<FolderItem[]>;
  getMetadata(): FolderMetadata;
}
```

--------------------------------

### Create Notifications with Options and Click Handler

Source: https://github.com/zen-browser/desktop/blob/dev/src/zen/tests/mochitests/alerts/file_dom_notifications.html

Defines two functions that create Notification objects with options including body, tag, and undefined dir/lang/icon. showNotification1 adds a click event listener that calls preventDefault, while showNotification2 returns the notification directly.

```javascript
 "use strict"; function showNotification1() { var options = { dir: undefined, lang: undefined, body: "Test body 1", tag: "Test tag", icon: undefined, }; var n = new Notification("Test title", options); n.addEventListener("click", function(event) { event.preventDefault(); }); return n; } function showNotification2() { var options = { dir: undefined, lang: undefined, body: "Test body 2", tag: "Test tag", icon: undefined, }; return new Notification("Test title", options); }
```

--------------------------------

### Iframe src setting for top window

Source: https://github.com/zen-browser/desktop/blob/dev/src/zen/tests/mochitests/sessionstore/browser_formdata_sample.html

Checks if the current window is the top-level window and, if so, sets the iframe's src attribute to an example.com URL with the same path. This is used to load an iframe when the page is the outer window.

```HTML
<html>
  <body>
    <iframe id="iframe"></iframe>
    <script>
      let isOuter = window == window.top;
      if (isOuter) {
        let iframe = document.getElementById("iframe");
        iframe.setAttribute("src", "https://example.com" + location.pathname);
      }
    </script>
  </body>
</html>
```

--------------------------------

### browser_sessionStorage.html: sessionStorage test with iframe and random parameter

Source: https://github.com/zen-browser/desktop/blob/dev/src/zen/tests/mochitests/sessionstore/browser_sessionStorage.html

Sets up a sessionStorage test page that distinguishes between the top-level window and an iframe. The outer page dynamically sets the iframe's src using a random parameter and a secure or insecure scheme, while both frames write a unique value to sessionStorage only if it is empty. The onload handler logs the load to help debug intermittent failures.

```javascript
let isOuter = window == window.top;
let args = window.location.search.slice(1).split("&");
let rand = args[0];
if (isOuter) {
  let iframe = document.getElementById("iframe");
  let isSecure = args.indexOf("secure") > -1;
  let scheme = isSecure ? "https" : "http";
  // WARNING This iframe might not finish loading before the top level document does
  // See intermittent bug 1775609, bug 2001322
  iframe.setAttribute("src", scheme + "://example.com" + location.pathname + "?" + rand);
}
if (sessionStorage.length === 0) {
  sessionStorage.test = (isOuter ? "outer" : "inner") + "-value-" + rand;
  document.title = sessionStorage.test;
}
// Log the load so that it becomes more obvious if intermittent failures reoccur
onload = () => {
  dump(`browser_sessionStorage.html ${isOuter ? 'TOP LEVEL' : 'IFRAME'} loaded\n`);
}
```

--------------------------------

### Test designMode with cross-domain iframe injection

Source: https://github.com/zen-browser/desktop/blob/dev/src/zen/tests/mochitests/sessionstore/browser_459906_sample.html

Test for bug 459906. Waits for two frames to fire DOMContentLoaded, then sets designMode on both frames. Overrides designMode getter on the first frame to inject a cross-domain file and ensure it loads before returning "on".

```javascript
var loadCount = 0;
frames[0].addEventListener("DOMContentLoaded", handleLoad);
frames[1].addEventListener("DOMContentLoaded", handleLoad);
function handleLoad() {
  if (++loadCount < 2) return;
  frames[0].removeEventListener("DOMContentLoaded", handleLoad);
  frames[1].removeEventListener("DOMContentLoaded", handleLoad);
  frames[0].document.designMode = "on";
  frames[0].document.__defineGetter__("designMode", function() {
    // inject a cross domain file ...
    var documentInjected = false;
    document.getElementsByTagName("iframe")[0].onload = function() {
      documentInjected = true;
    };
    frames[0].location = "browser_459906_empty.html";
    // ... and ensure that it has time to load
    for (var c = 0; !documentInjected && c < 20; c++) {
      var r = new XMLHttpRequest();
      r.open("GET", location.href, false);
      r.overrideMimeType("text/plain");
      r.send(null);
    }
    return "on";
  });
  frames[1].document.designMode = "on";
}
```

--------------------------------

### Handle DOMContentLoaded to set hash and toggle input types

Source: https://github.com/zen-browser/desktop/blob/dev/src/zen/tests/mochitests/sessionstore/browser_466937_sample.html

Used in a test page for bug 466937. On DOMContentLoaded, if no hash is present, sets the hash to '#ready'; otherwise, changes the type of elements with IDs 'thief' and 'reverse_thief' to 'file' and 'text' respectively. The listener runs only once.

```javascript
window.addEventListener("DOMContentLoaded", function() {
  if (!document.location.hash) {
    document.location.hash = "#ready";
  } else {
    document.getElementById("thief").type = "file";
    document.getElementById("reverse_thief").type = "text";
  }
}, {once: true});
```

--------------------------------

### Bug 461743 Test Script

Source: https://github.com/zen-browser/desktop/blob/dev/src/zen/tests/mochitests/sessionstore/browser_461743_sample.html

JavaScript test for bug 461743. It sets up two frames, overrides MutationEvent.prototype.toString to return a chrome URL or an exploit URL, and uses DOMNodeInserted listeners to trigger the exploit and report completion.

```javascript
var chromeUrl = "chrome://global/content/mozilla.html";
var exploitUrl = "javascript:try { document.body.innerHTML = Components.utils.reportError; } catch (ex) { }";
var loadCount = 0;

frames[0].addEventListener("DOMContentLoaded", handleLoad);
frames[1].addEventListener("DOMContentLoaded", handleLoad);

function handleLoad() {
  if (++loadCount < 2) return;

  frames[0].removeEventListener("DOMContentLoaded", handleLoad);
  frames[1].removeEventListener("DOMContentLoaded", handleLoad);

  var flip = 0;
  MutationEvent.prototype.toString = function() {
    return flip++ == 0 ? chromeUrl : exploitUrl;
  };

  var href = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(frames[1].location), "href").get;
  var loadChrome = { handleEvent: href };
  var loadExploit = { handleEvent: href };

  function delay() {
    var xhr = new XMLHttpRequest();
    xhr.open("GET", location.href, false);
    xhr.send(null);
  }

  function done() {
    var event = new MessageEvent("461743", {
      bubbles: true,
      cancelable: false,
      data: "done",
      origin: location.href,
      source: window
    });
    document.dispatchEvent(event);

    frames[0].document.removeEventListener("DOMNodeInserted", loadChrome, true);
    frames[0].document.removeEventListener("DOMNodeInserted", delay, true);
    frames[0].document.removeEventListener("DOMNodeInserted", loadExploit, true);
    frames[0].document.removeEventListener("DOMNodeInserted", done, true);
  }

  frames[0].document.addEventListener("DOMNodeInserted", loadChrome, true);
  frames[0].document.addEventListener("DOMNodeInserted", delay, true);
  frames[0].document.addEventListener("DOMNodeInserted", loadExploit, true);
  frames[0].document.addEventListener("DOMNodeInserted", done, true);

  frames[0].document.designMode = "on";
}
```
Tokens:
Raw