@internetarchive/histogram-date-range 1.2.2-alpha-webdev7377.7 → 1.3.0

package/dist/src/histogram-date-range.js

@@ -5,6 +5,7 @@ import customParseFormat from 'dayjs/esm/plugin/customParseFormat';
 import { css, html, LitElement, nothing, svg, } from 'lit';
 import { customElement, property, state } from 'lit/decorators.js';
 import { live } from 'lit/directives/live.js';
+import { classMap } from 'lit/directives/class-map.js';
 dayjs.extend(customParseFormat);
 // these values can be overridden via the component's HTML (camelCased) attributes
 const WIDTH = 180;
@@ -51,7 +52,17 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         this.bins = [];
         /** If true, update events will not be canceled by the date inputs receiving focus */
         this.updateWhileFocused = false;
-        /** What interval bins should be rounded to for display */
+        /**
+         * What interval bins should be snapped to for determining their time ranges.
+         *  - `none` (default): Bins should each represent an identical duration of time,
+         *     without regard for the actual dates represented.
+         *  - `month`: Bins should each represent one or more full, non-overlapping months.
+         *     The bin ranges will be "snapped" to the nearest month boundaries, which can
+         *     result in bins that represent different amounts of time, particularly if the
+         *     provided bins do not evenly divide the provided date range, or if the months
+         *     represented are of different lengths.
+         *  - `year`: Same as `month`, but snapping to year boundaries instead of months.
+         */
         this.binSnapping = 'none';
         // internal reactive properties not exposed as attributes
         this._tooltipOffset = 0;
@@ -141,7 +152,8 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         }
         this._histWidth = this.width - this.sliderWidth * 2;
         this._minDateMS = this.snapTimestamp(this.getMSFromString(this.minDate));
-        // NB: The max date string, converted as-is to ms, represents the _start_ of the final date interval; we want the _end_.
+        // NB: The max date string, converted as-is to ms, represents the *start* of the
+        // final date interval; we want the *end*, so we add any snap interval/offset.
         this._maxDateMS =
             this.snapTimestamp(this.getMSFromString(this.maxDate) + this.snapInterval) + this.snapEndOffset;
         this._binWidth = this._histWidth / this._numBins;
@@ -196,6 +208,7 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
                 return this.snapToMonth(timestamp);
             case 'none':
             default:
+                // We still align it to second boundaries to resolve minor discrepancies
                 return this.snapToNextSecond(timestamp);
         }
     }
@@ -263,7 +276,8 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         }
     }
     /**
-     * Offset added to the end of each bin to ensure disjoin intervals, if applicable.
+     * Offset added to the end of each bin to ensure disjoint intervals,
+     * depending on whether snapping is enabled and there are multiple bins.
      */
     get snapEndOffset() {
         return this.binSnapping !== 'none' && this._numBins > 1 ? -1 : 0;
@@ -273,8 +287,8 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
      * Falls back to `dateFormat` if not provided.
      */
     get tooltipDateFormat() {
-        var _a, _b;
-        return (_b = (_a = this._tooltipDateFormat) !== null && _a !== void 0 ? _a : this.dateFormat) !== null && _b !== void 0 ? _b : DATE_FORMAT;
+        var _a;
+        return (_a = this._tooltipDateFormat) !== null && _a !== void 0 ? _a : this.dateFormat;
     }
     set tooltipDateFormat(value) {
         this._tooltipDateFormat = value;
@@ -354,9 +368,9 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         const formattedNumItems = Number(dataset.numItems).toLocaleString();
         this._tooltipOffset =
             x + (this._binWidth - this.sliderWidth - this.tooltipWidth) / 2;
-        this._tooltipContent = html `
-      ${formattedNumItems} ${itemsText}<br />
-      ${dataset.tooltip}
+        this._tooltipContent = html `
+      ${formattedNumItems} ${itemsText}<br />
+      ${dataset.tooltip}
     `;
         this._tooltipVisible = true;
     }
@@ -552,25 +566,25 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         // border-radius); used as part of a SVG quadratic curve. see
         // https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands
         const cs = SLIDER_CORNER_SIZE;
-        const sliderShape = `
-            M${this.minSliderX},0
-            h-${this.sliderWidth - cs}
-            q-${cs},0 -${cs},${cs}
-            v${this.height - cs * 2}
-            q0,${cs} ${cs},${cs}
-            h${this.sliderWidth - cs}
+        const sliderShape = `
+            M${this.minSliderX},0
+            h-${this.sliderWidth - cs}
+            q-${cs},0 -${cs},${cs}
+            v${this.height - cs * 2}
+            q0,${cs} ${cs},${cs}
+            h${this.sliderWidth - cs}
           `;
         return this.generateSliderSVG(this.minSliderX, 'slider-min', sliderShape);
     }
     get maxSliderTemplate() {
         const cs = SLIDER_CORNER_SIZE;
-        const sliderShape = `
-            M${this.maxSliderX},0
-            h${this.sliderWidth - cs}
-            q${cs},0 ${cs},${cs}
-            v${this.height - cs * 2}
-            q0,${cs} -${cs},${cs}
-            h-${this.sliderWidth - cs}
+        const sliderShape = `
+            M${this.maxSliderX},0
+            h${this.sliderWidth - cs}
+            q${cs},0 ${cs},${cs}
+            v${this.height - cs * 2}
+            q0,${cs} -${cs},${cs}
+            h-${this.sliderWidth - cs}
           `;
         return this.generateSliderSVG(this.maxSliderX, 'slider-max', sliderShape);
     }
@@ -578,40 +592,43 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         // whether the curved part of the slider is facing towards the left (1), ie
         // minimum, or facing towards the right (-1), ie maximum
         const k = id === 'slider-min' ? 1 : -1;
-        return svg `
-    <svg
-      id="${id}"
-      class="
-      ${this.disabled ? '' : 'draggable'}
-      ${this._isDragging ? 'dragging' : ''}"
-      @pointerdown="${this.drag}"
-    >
-      <path d="${sliderShape} z" fill="${sliderColor}" />
-      <rect
-        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.4 * k}"
-        y="${this.height / 3}"
-        width="1"
-        height="${this.height / 3}"
-        fill="white"
-      />
-      <rect
-        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.6 * k}"
-        y="${this.height / 3}"
-        width="1"
-        height="${this.height / 3}"
-        fill="white"
-      />
-    </svg>
+        const sliderClasses = classMap({
+            slider: true,
+            draggable: !this.disabled,
+            dragging: this._isDragging,
+        });
+        return svg `
+    <svg
+      id=${id}
+      class=${sliderClasses}
+      @pointerdown=${this.drag}
+    >
+      <path d="${sliderShape} z" fill="${sliderColor}" />
+      <rect
+        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.4 * k}"
+        y="${this.height / 3}"
+        width="1"
+        height="${this.height / 3}"
+        fill="white"
+      />
+      <rect
+        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.6 * k}"
+        y="${this.height / 3}"
+        width="1"
+        height="${this.height / 3}"
+        fill="white"
+      />
+    </svg>
     `;
     }
     get selectedRangeTemplate() {
-        return svg `
-      <rect
-        x="${this.minSliderX}"
-        y="0"
-        width="${this.maxSliderX - this.minSliderX}"
-        height="${this.height}"
-        fill="${selectedRangeColor}"
+        return svg `
+      <rect
+        x="${this.minSliderX}"
+        y="0"
+        width="${this.maxSliderX - this.minSliderX}"
+        height="${this.height}"
+        fill="${selectedRangeColor}"
       />`;
     }
     get histogramTemplate() {
@@ -629,22 +646,22 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
             // between adjacent bars (eg when viewing the tooltips or when trying to
             // extend the range by clicking on a bar)
             const barStyle = `stroke-dasharray: 0 ${barWidth} ${barHeight} ${barWidth} 0 ${barHeight}`;
-            const bar = svg `
-        <rect
-          class="bar"
-          style=${barStyle}
-          x=${x}
-          y=${this.height - barHeight}
-          width=${barWidth}
-          height=${barHeight}
-          @pointerenter=${this.showTooltip}
-          @pointerleave=${this.hideTooltip}
-          @click=${this.handleBarClick}
-          fill=${barFill}
-          data-num-items=${data.value}
-          data-bin-start=${data.binStart}
-          data-bin-end=${data.binEnd}
-          data-tooltip=${data.tooltip}
+            const bar = svg `
+        <rect
+          class="bar"
+          style=${barStyle}
+          x=${x}
+          y=${this.height - barHeight}
+          width=${barWidth}
+          height=${barHeight}
+          @pointerenter=${this.showTooltip}
+          @pointerleave=${this.hideTooltip}
+          @click=${this.handleBarClick}
+          fill=${barFill}
+          data-num-items=${data.value}
+          data-bin-start=${data.binStart}
+          data-bin-end=${data.binEnd}
+          data-tooltip=${data.tooltip}
         />`;
             x += xScale;
             return bar;
@@ -681,31 +698,31 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
      * https://lit.dev/docs/templates/directives/#live
      */
     get minInputTemplate() {
-        return html `
-      <input
-        id="date-min"
-        placeholder="${this.dateFormat}"
-        type="text"
-        @focus="${this.handleInputFocus}"
-        @blur="${this.handleMinDateInput}"
-        @keyup="${this.handleKeyUp}"
-        .value="${live(this.minSelectedDate)}"
-        ?disabled="${this.disabled}"
-      />
+        return html `
+      <input
+        id="date-min"
+        placeholder=${this.dateFormat}
+        type="text"
+        @focus=${this.handleInputFocus}
+        @blur=${this.handleMinDateInput}
+        @keyup=${this.handleKeyUp}
+        .value=${live(this.minSelectedDate)}
+        ?disabled=${this.disabled}
+      />
     `;
     }
     get maxInputTemplate() {
-        return html `
-      <input
-        id="date-max"
-        placeholder="${this.dateFormat}"
-        type="text"
-        @focus="${this.handleInputFocus}"
-        @blur="${this.handleMaxDateInput}"
-        @keyup="${this.handleKeyUp}"
-        .value="${live(this.maxSelectedDate)}"
-        ?disabled="${this.disabled}"
-      />
+        return html `
+      <input
+        id="date-max"
+        placeholder=${this.dateFormat}
+        type="text"
+        @focus=${this.handleInputFocus}
+        @blur=${this.handleMaxDateInput}
+        @keyup=${this.handleKeyUp}
+        .value=${live(this.maxSelectedDate)}
+        ?disabled=${this.disabled}
+      />
     `;
     }
     get minLabelTemplate() {
@@ -715,184 +732,187 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         return html `<label for="date-max" class="sr-only">Maximum date:</label>`;
     }
     get tooltipTemplate() {
-        return html `
-      <style>
-        #tooltip {
-          width: ${this.tooltipWidth}px;
-          height: ${this.tooltipHeight}px;
-          top: ${-9 - this.tooltipHeight}px;
-          left: ${this._tooltipOffset}px;
-          display: ${this._tooltipVisible ? 'block' : 'none'};
-        }
-        #tooltip:after {
-          left: ${this.tooltipWidth / 2}px;
-        }
-      </style>
-      <div id="tooltip">${this._tooltipContent}</div>
+        return html `
+      <style>
+        #tooltip {
+          width: ${this.tooltipWidth}px;
+          height: ${this.tooltipHeight}px;
+          top: ${-9 - this.tooltipHeight}px;
+          left: ${this._tooltipOffset}px;
+          display: ${this._tooltipVisible ? 'block' : 'none'};
+        }
+        #tooltip:after {
+          left: ${this.tooltipWidth / 2}px;
+        }
+      </style>
+      <div id="tooltip">${this._tooltipContent}</div>
     `;
     }
     get noDataTemplate() {
-        return html `
-      <div class="missing-data-message">${this.missingDataMessage}</div>
+        return html `
+      <div class="missing-data-message">${this.missingDataMessage}</div>
     `;
     }
     get activityIndicatorTemplate() {
         if (!this.loading) {
             return nothing;
         }
-        return html `
-      <ia-activity-indicator mode="processing"> </ia-activity-indicator>
+        return html `
+      <ia-activity-indicator mode="processing"> </ia-activity-indicator>
     `;
     }
     render() {
         if (!this.hasBinData) {
             return this.noDataTemplate;
         }
-        return html `
-      <div
-        id="container"
-        class="
-          noselect
-          ${this._isDragging ? 'dragging' : ''}
-        "
-        style="width: ${this.width}px"
-      >
-        ${this.activityIndicatorTemplate} ${this.tooltipTemplate}
-        <div
-          class="inner-container
-          ${this.disabled ? 'disabled' : ''}"
-        >
-          <svg
-            width="${this.width}"
-            height="${this.height}"
-            @pointerleave="${this.drop}"
-          >
-            ${this.selectedRangeTemplate}
-            <svg id="histogram">${this.histogramTemplate}</svg>
-            ${this.minSliderTemplate} ${this.maxSliderTemplate}
-          </svg>
-          <div id="inputs">
-            ${this.minLabelTemplate} ${this.minInputTemplate}
-            <div class="dash">-</div>
-            ${this.maxLabelTemplate} ${this.maxInputTemplate}
-            <slot name="inputs-right-side"></slot>
-          </div>
-        </div>
-      </div>
+        return html `
+      <div
+        id="container"
+        class="
+          noselect
+          ${this._isDragging ? 'dragging' : ''}
+        "
+        style="width: ${this.width}px"
+      >
+        ${this.activityIndicatorTemplate} ${this.tooltipTemplate}
+        <div
+          class="inner-container
+          ${this.disabled ? 'disabled' : ''}"
+        >
+          <svg
+            width="${this.width}"
+            height="${this.height}"
+            @pointerleave="${this.drop}"
+          >
+            ${this.selectedRangeTemplate}
+            <svg id="histogram">${this.histogramTemplate}</svg>
+            ${this.minSliderTemplate} ${this.maxSliderTemplate}
+          </svg>
+          <div id="inputs">
+            ${this.minLabelTemplate} ${this.minInputTemplate}
+            <div class="dash">-</div>
+            ${this.maxLabelTemplate} ${this.maxInputTemplate}
+            <slot name="inputs-right-side"></slot>
+          </div>
+        </div>
+      </div>
     `;
     }
 };
-HistogramDateRange.styles = css `
-    .missing-data-message {
-      text-align: center;
-    }
-    #container {
-      margin: 0;
-      touch-action: none;
-      position: relative;
-    }
-    .disabled {
-      opacity: 0.3;
-    }
-    ia-activity-indicator {
-      position: absolute;
-      left: calc(50% - 10px);
-      top: 10px;
-      width: 20px;
-      height: 20px;
-      --activityIndicatorLoadingDotColor: rgba(0, 0, 0, 0);
-      --activityIndicatorLoadingRingColor: ${activityIndicatorColor};
-    }
-
-    /* prevent selection from interfering with tooltip, especially on mobile */
-    /* https://stackoverflow.com/a/4407335/1163042 */
-    .noselect {
-      -webkit-touch-callout: none; /* iOS Safari */
-      -webkit-user-select: none; /* Safari */
-      -moz-user-select: none; /* Old versions of Firefox */
-      -ms-user-select: none; /* Internet Explorer/Edge */
-      user-select: none; /* current Chrome, Edge, Opera and Firefox */
-    }
-    .bar {
-      /* create a transparent border around the hist bars to prevent "gaps" and
-      flickering when moving around between bars. this also helps with handling
-      clicks on the bars, preventing users from being able to click in between
-      bars */
-      stroke: rgba(0, 0, 0, 0);
-      /* ensure transparent stroke wide enough to cover gap between bars */
-      stroke-width: 2px;
-    }
-    .bar:hover {
-      /* highlight currently hovered bar */
-      fill-opacity: 0.7;
-    }
-    .disabled .bar:hover {
-      /* ensure no visual hover interaction when disabled */
-      fill-opacity: 1;
-    }
-    /****** histogram ********/
-    #tooltip {
-      position: absolute;
-      background: ${tooltipBackgroundColor};
-      color: ${tooltipTextColor};
-      text-align: center;
-      border-radius: 3px;
-      padding: 2px;
-      font-size: ${tooltipFontSize};
-      font-family: ${tooltipFontFamily};
-      touch-action: none;
-      pointer-events: none;
-    }
-    #tooltip:after {
-      content: '';
-      position: absolute;
-      margin-left: -5px;
-      top: 100%;
-      /* arrow */
-      border: 5px solid ${tooltipTextColor};
-      border-color: ${tooltipBackgroundColor} transparent transparent
-        transparent;
-    }
-    /****** slider ********/
-    .draggable:hover {
-      cursor: grab;
-    }
-    .dragging {
-      cursor: grabbing !important;
-    }
-    /****** inputs ********/
-    #inputs {
-      display: flex;
-      justify-content: center;
-      margin: ${inputRowMargin};
-    }
-    #inputs .dash {
-      position: relative;
-      bottom: -1px;
-      align-self: center; /* Otherwise the dash sticks to the top while the inputs grow */
-    }
-    input {
-      width: ${inputWidth};
-      margin: 0 3px;
-      border: ${inputBorder};
-      border-radius: 2px !important;
-      text-align: center;
-      font-size: ${inputFontSize};
-      font-family: ${inputFontFamily};
-    }
-    .sr-only {
-      position: absolute !important;
-      width: 1px !important;
-      height: 1px !important;
-      margin: 0 !important;
-      padding: 0 !important;
-      border: 0 !important;
-      overflow: hidden !important;
-      white-space: nowrap !important;
-      clip: rect(1px, 1px, 1px, 1px) !important;
-      -webkit-clip-path: inset(50%) !important;
-      clip-path: inset(50%) !important;
-    }
+HistogramDateRange.styles = css `
+    .missing-data-message {
+      text-align: center;
+    }
+    #container {
+      margin: 0;
+      touch-action: none;
+      position: relative;
+    }
+    .disabled {
+      opacity: 0.3;
+    }
+    ia-activity-indicator {
+      position: absolute;
+      left: calc(50% - 10px);
+      top: 10px;
+      width: 20px;
+      height: 20px;
+      --activityIndicatorLoadingDotColor: rgba(0, 0, 0, 0);
+      --activityIndicatorLoadingRingColor: ${activityIndicatorColor};
+    }
+
+    /* prevent selection from interfering with tooltip, especially on mobile */
+    /* https://stackoverflow.com/a/4407335/1163042 */
+    .noselect {
+      -webkit-touch-callout: none; /* iOS Safari */
+      -webkit-user-select: none; /* Safari */
+      -moz-user-select: none; /* Old versions of Firefox */
+      -ms-user-select: none; /* Internet Explorer/Edge */
+      user-select: none; /* current Chrome, Edge, Opera and Firefox */
+    }
+    .bar {
+      /* create a transparent border around the hist bars to prevent "gaps" and
+      flickering when moving around between bars. this also helps with handling
+      clicks on the bars, preventing users from being able to click in between
+      bars */
+      stroke: rgba(0, 0, 0, 0);
+      /* ensure transparent stroke wide enough to cover gap between bars */
+      stroke-width: 2px;
+    }
+    .bar:hover {
+      /* highlight currently hovered bar */
+      fill-opacity: 0.7;
+    }
+    .disabled .bar:hover {
+      /* ensure no visual hover interaction when disabled */
+      fill-opacity: 1;
+    }
+    /****** histogram ********/
+    #tooltip {
+      position: absolute;
+      background: ${tooltipBackgroundColor};
+      color: ${tooltipTextColor};
+      text-align: center;
+      border-radius: 3px;
+      padding: 2px;
+      font-size: ${tooltipFontSize};
+      font-family: ${tooltipFontFamily};
+      touch-action: none;
+      pointer-events: none;
+    }
+    #tooltip:after {
+      content: '';
+      position: absolute;
+      margin-left: -5px;
+      top: 100%;
+      /* arrow */
+      border: 5px solid ${tooltipTextColor};
+      border-color: ${tooltipBackgroundColor} transparent transparent
+        transparent;
+    }
+    /****** slider ********/
+    .slider {
+      shape-rendering: crispEdges; /* So the slider doesn't get blurry if dragged between pixels */
+    }
+    .draggable:hover {
+      cursor: grab;
+    }
+    .dragging {
+      cursor: grabbing !important;
+    }
+    /****** inputs ********/
+    #inputs {
+      display: flex;
+      justify-content: center;
+      margin: ${inputRowMargin};
+    }
+    #inputs .dash {
+      position: relative;
+      bottom: -1px;
+      align-self: center; /* Otherwise the dash sticks to the top while the inputs grow */
+    }
+    input {
+      width: ${inputWidth};
+      margin: 0 3px;
+      border: ${inputBorder};
+      border-radius: 2px !important;
+      text-align: center;
+      font-size: ${inputFontSize};
+      font-family: ${inputFontFamily};
+    }
+    .sr-only {
+      position: absolute !important;
+      width: 1px !important;
+      height: 1px !important;
+      margin: 0 !important;
+      padding: 0 !important;
+      border: 0 !important;
+      overflow: hidden !important;
+      white-space: nowrap !important;
+      clip: rect(1px, 1px, 1px, 1px) !important;
+      -webkit-clip-path: inset(50%) !important;
+      clip-path: inset(50%) !important;
+    }
   `;
 __decorate([
     property({ type: Number })