archivalo-oss/replayweb.page
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Add updateFavicons to the embed options list (#305)

Browse Source 
- Adds info on `updateFavicons` attribute to the table
- Adds note on timestamp format
This commit is contained in:
Henry Wilkinson
2024-04-09 17:19:28 -07:00
committed by GitHub
parent 01a6ebc5b6
commit fcd59b634b
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
site/docs/embedding/index.md
+4 -3
View File
@@ -135,12 +135,13 @@ The `#!html <replay-web-page>` tag is a web component that supports a number of
|:-------------|:-----------------| |:-------------|:-----------------|
| `source` | Source URL for the archived item. This should be one of the [supported formats](../user-guide/index.md#supported-formats) loaded from one of the [support locations](../user-guide/locations.md) and is required. | | `source` | Source URL for the archived item. This should be one of the [supported formats](../user-guide/index.md#supported-formats) loaded from one of the [support locations](../user-guide/locations.md) and is required. |
| `url` | The starting URL to load from the archive. If omitted, will start with the page list or URL search view. | | `url` | The starting URL to load from the archive. If omitted, will start with the page list or URL search view. |
| `ts` | The timestamp of the starting URL to load. If omitted, the latest available version is used. | | `ts` | The ISO 8601 timestamp of the starting URL to load. If omitted, the latest available version is used. |
| `deepLink` | If set, ReplayWeb.page will modify the URL of the page to allow for 'deep linking' to exact pages in the embed. | | `deepLink` | If set, ReplayWeb.page will modify the URL of the page to allow for 'deep linking' to exact pages in the embed. |
| `embed` | (`default` / `full` / `replayonly` / `replay-with-info` ) - See [Embed Modes](#embed-modes) above. | `updateFavicons`| If set, ReplayWeb.page will set the favicon of the page to the current webpage being viewed. Only supported in Chrome.|
| `embed` | (`default` / `full` / `replayonly` / `replay-with-info` ) - See [Embed Modes](#embed-modes) above. |
| `swName` | Service Worker filename (default: `sw.js`). Set if using different name, don't include path, only filename | | `swName` | Service Worker filename (default: `sw.js`). Set if using different name, don't include path, only filename |
| `replayBase` | Location of the service worker file (eg. sw.js), defaults to `./replay/` as mentioned above, but can be overridden. | | `replayBase` | Location of the service worker file (eg. sw.js), defaults to `./replay/` as mentioned above, but can be overridden. |
| `coll` | Internal ID for this collection, usually generated automatically. | `coll` | Internal ID for this collection, usually generated automatically. |
| `config` | Extra per collection config options (such as custom fuzzy matching rules, TODO add more info!) | | `config` | Extra per collection config options (such as custom fuzzy matching rules, TODO add more info!) |
| `sandbox` | If set, will iframe in `sandbox`. Provides extra isolation, but prevents PDFs from loading in an embed, and may result in links opening in new windows. | | `sandbox` | If set, will iframe in `sandbox`. Provides extra isolation, but prevents PDFs from loading in an embed, and may result in links opening in new windows. |
| `noWebWorker`| If set, will not use Web Worker for loading, only Service Worker. May be useful for certain loading edge cases. | | `noWebWorker`| If set, will not use Web Worker for loading, only Service Worker. May be useful for certain loading edge cases. |