@internetarchive/cdxsummary

CDX Summary Web Component

Assuming that a CDX Summary JSON file is generated from CDX files or WARC collections using the cdxsummary CLI tool, use the following Web Component to render it as an interactive HTML markup.

<cdx-summary src="CDX_SUMMARY_JSON_URL"></cdx-summary>

Alternatively, render a summary from a web collection/item of Internet Archive's Petabox, if a corresponding summary file is generated already.

<cdx-summary item="PETABOX_ITEM_OR_COLLECTION_ID"></cdx-summary>

One of the src and item attributes is mandatory for the element to render.

By default, sample capture playback links (i.e., memento URIs or URI-Ms) point to https://web.archive.org/web/, but this can be customized by specifying the playback attribute. To control the maximum number of thumbnails of random sample captures (rendered by embedding them in iframes), specify a positive integer in the thumbs attribute. Specify a space-separated list of terms thumbs, samples, and description in the fold attribute to configure the initial folding/hiding of thumbnails, list of random sample capture playback URIs, and descriptions (the latter, if folded, truncates the paragraph at one line and toggles when clicked). The element accepts a name attribute, which defaults to the name of the summary file (without extensions). A type attribute can be used to customize textual descriptions with a value of collection, item, or CDX (defaults to CDX). A report attribute points to a comprehensive version of the summary file, which is derived from the item attribute for Petabox items/collections, unless specified explicitly. Number reported in various table cells can be formatted using format attribute with values short, percent, or local (defaults to local). The code below illustrates the usage of these attributes.

<cdx-summary src="https://example.org/files/covid-collection-cdx.summary.json"
             report="https://example.org/files/covid-collection-cdx.report.json.gz"
             type="collection"
             name="COVID-19 Collection"
             format="short"
             thumbs="10"
             playback="https://archive.example.com/memento/"
             fold="thumbs samples description">
</cdx-summary>

Customize the style of various parts using any of the following CSS custom properties (variables). For example, override the --cdxsummary-thumb-scale CSS variable to change the size of the thumbnail from the original 960x600 iframe dimension (default scale is set to 0.3).

cdx-summary {
  --cdxsummary-main-txt-color: initial;
  --cdxsummary-main-bg-color: initial;
  --cdxsummary-main-font-family: sans-serif;
  --cdxsummary-main-font-size: initial;
  --cdxsummary-main-margin: 0;
  --cdxsummary-main-padding: 5px;
  --cdxsummary-mono-font-family: monospace;
  --cdxsummary-link-txt-color: blue;
  --cdxsummary-link-txt-decoration: underline;
  --cdxsummary-link-bg-color: inherit;
  --cdxsummary-info-txt-color: inherit;
  --cdxsummary-info-bg-color: inherit;
  --cdxsummary-info-font-family: inherit;
  --cdxsummary-info-font-size: inherit;
  --cdxsummary-info-font-style: italic;
  --cdxsummary-info-border: initial;
  --cdxsummary-info-border-radius: initial;
  --cdxsummary-info-margin: 5px;
  --cdxsummary-info-padding: 5px;
  --cdxsummary-h2-txt-color: inherit;
  --cdxsummary-h2-bg-color: inherit;
  --cdxsummary-h2-font-family: inherit;
  --cdxsummary-h2-font-size: 1.5em;
  --cdxsummary-h2-margin: 1em 0 0.7em;
  --cdxsummary-h2-padding: initial;
  --cdxsummary-tbl-txt-color: inherit;
  --cdxsummary-tbl-bg-color: inherit;
  --cdxsummary-tbl-hdr-txt-color: white;
  --cdxsummary-tbl-hdr-bg-color: gray;
  --cdxsummary-tbl-alt-txt-color: inherit;
  --cdxsummary-tbl-alt-bg-color: inherit;
  --cdxsummary-tbl-border: 1px solid gray;
  --cdxsummary-tbl-font-family: inherit;
  --cdxsummary-tbl-font-size: inherit;
  --cdxsummary-tbl-margin: initial;
  --cdxsummary-btn-txt-color: white;
  --cdxsummary-btn-bg-color: gray;
  --cdxsummary-btn-font-family: inherit;
  --cdxsummary-btn-font-size: inherit;
  --cdxsummary-btn-border: tbl-border;
  --cdxsummary-btn-border-radius: 5px;
  --cdxsummary-btn-margin: 0 0 10px;
  --cdxsummary-btn-padding: 5px 10px;
  --cdxsummary-thumb-border: tbl-border;
  --cdxsummary-thumb-border-radius: 5px;
  --cdxsummary-thumb-scale: 0.3;
}

Alternatively, use the interactive tester interface to customize the style and copy the generated code for integration.