@primer/view-components 0.0.100 → 0.0.102

package/app/components/primer/alpha/tool-tip-element.js

@@ -0,0 +1,352 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ToolTipElement_instances, _ToolTipElement_abortController, _ToolTipElement_align, _ToolTipElement_side, _ToolTipElement_allowUpdatePosition, _ToolTipElement_update, _ToolTipElement_updatePosition;
+import { getAnchoredPosition } from '@primer/behaviors';
+const TOOLTIP_OPEN_CLASS = 'tooltip-open';
+const TOOLTIP_ARROW_EDGE_OFFSET = 6;
+const DIRECTION_CLASSES = [
+    'tooltip-n',
+    'tooltip-s',
+    'tooltip-e',
+    'tooltip-w',
+    'tooltip-ne',
+    'tooltip-se',
+    'tooltip-nw',
+    'tooltip-sw'
+];
+class ToolTipElement extends HTMLElement {
+    constructor() {
+        super(...arguments);
+        _ToolTipElement_instances.add(this);
+        _ToolTipElement_abortController.set(this, void 0);
+        _ToolTipElement_align.set(this, 'center');
+        _ToolTipElement_side.set(this, 'outside-bottom');
+        _ToolTipElement_allowUpdatePosition.set(this, false);
+    }
+    styles() {
+        return `
+      :host {
+        position: absolute;
+        z-index: 1000000;
+        padding: .5em .75em;
+        font: normal normal 11px/1.5 -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
+        -webkit-font-smoothing: subpixel-antialiased;
+        color: var(--color-fg-on-emphasis);
+        text-align: center;
+        text-decoration: none;
+        text-shadow: none;
+        text-transform: none;
+        letter-spacing: normal;
+        word-wrap: break-word;
+        white-space: pre;
+        background: var(--color-neutral-emphasis-plus);
+        border-radius: 6px;
+        opacity: 0;
+        max-width: 250px;
+        word-wrap: break-word;
+        white-space: normal;
+        width: max-content;
+      }
+
+      :host:before{
+        position: absolute;
+        z-index: 1000001;
+        color: var(--color-neutral-emphasis-plus);
+        content: "";
+        border: 6px solid transparent;
+        opacity: 0
+      }
+
+      @keyframes tooltip-appear {
+        from {
+          opacity: 0
+        }
+        to {
+          opacity: 1
+        }
+      }
+
+      :host:after{
+        position: absolute;
+        display: block;
+        right: 0;
+        left: 0;
+        height: 12px;
+        content: ""
+      }
+
+      :host(.${TOOLTIP_OPEN_CLASS}),
+      :host(.${TOOLTIP_OPEN_CLASS}):before {
+        animation-name: tooltip-appear;
+        animation-duration: .1s;
+        animation-fill-mode: forwards;
+        animation-timing-function: ease-in;
+        animation-delay: .4s
+      }
+
+      :host(.tooltip-s):before,
+      :host(.tooltip-n):before {
+        right: 50%;
+        margin-right: -${TOOLTIP_ARROW_EDGE_OFFSET}px;
+      }
+
+      :host(.tooltip-s):before,
+      :host(.tooltip-se):before,
+      :host(.tooltip-sw):before {
+        bottom: 100%;
+        border-bottom-color: var(--color-neutral-emphasis-plus)
+      }
+
+      :host(.tooltip-s):after,
+      :host(.tooltip-se):after,
+      :host(.tooltip-sw):after {
+        bottom: 100%
+      }
+
+      :host(.tooltip-n):before,
+      :host(.tooltip-ne):before,
+      :host(.tooltip-nw):before {
+        top: 100%;
+        border-top-color: var(--color-neutral-emphasis-plus)
+      }
+
+      :host(.tooltip-n):after,
+      :host(.tooltip-ne):after,
+      :host(.tooltip-nw):after {
+        top: 100%
+      }
+
+      :host(.tooltip-se):before,
+      :host(.tooltip-ne):before {
+        left: 0;
+        margin-left: ${TOOLTIP_ARROW_EDGE_OFFSET}px;
+      }
+
+      :host(.tooltip-sw):before,
+      :host(.tooltip-nw):before {
+        right: 0;
+        margin-right: ${TOOLTIP_ARROW_EDGE_OFFSET}px;
+      }
+
+      :host(.tooltip-w):before {
+        top: 50%;
+        bottom: 50%;
+        left: 100%;
+        margin-top: -6px;
+        border-left-color: var(--color-neutral-emphasis-plus)
+      }
+
+      :host(.tooltip-e):before {
+        top: 50%;
+        right: 100%;
+        bottom: 50%;
+        margin-top: -6px;
+        border-right-color: var(--color-neutral-emphasis-plus)
+      }
+    `;
+    }
+    get htmlFor() {
+        return this.getAttribute('for') || '';
+    }
+    set htmlFor(value) {
+        this.setAttribute('for', value);
+    }
+    get type() {
+        const type = this.getAttribute('data-type');
+        return type === 'label' ? 'label' : 'description';
+    }
+    set type(value) {
+        this.setAttribute('data-type', value);
+    }
+    get direction() {
+        return (this.getAttribute('data-direction') || 's');
+    }
+    set direction(value) {
+        this.setAttribute('data-direction', value);
+    }
+    get control() {
+        return this.ownerDocument.getElementById(this.htmlFor);
+    }
+    connectedCallback() {
+        var _a;
+        if (!this.shadowRoot) {
+            const shadow = this.attachShadow({ mode: 'open' });
+            // eslint-disable-next-line github/no-inner-html
+            shadow.innerHTML = `
+        <style>
+          ${this.styles()}
+        </style>
+        <slot></slot>
+      `;
+        }
+        this.hidden = true;
+        __classPrivateFieldSet(this, _ToolTipElement_allowUpdatePosition, true, "f");
+        if (!this.id) {
+            this.id = `tooltip-${Date.now()}-${(Math.random() * 10000).toFixed(0)}`;
+        }
+        if (!this.control)
+            return;
+        this.setAttribute('role', 'tooltip');
+        (_a = __classPrivateFieldGet(this, _ToolTipElement_abortController, "f")) === null || _a === void 0 ? void 0 : _a.abort();
+        __classPrivateFieldSet(this, _ToolTipElement_abortController, new AbortController(), "f");
+        const { signal } = __classPrivateFieldGet(this, _ToolTipElement_abortController, "f");
+        this.addEventListener('mouseleave', this, { signal });
+        this.control.addEventListener('mouseenter', this, { signal });
+        this.control.addEventListener('mouseleave', this, { signal });
+        this.control.addEventListener('focus', this, { signal });
+        this.control.addEventListener('blur', this, { signal });
+        this.ownerDocument.addEventListener('keydown', this, { signal });
+        __classPrivateFieldGet(this, _ToolTipElement_instances, "m", _ToolTipElement_update).call(this);
+    }
+    disconnectedCallback() {
+        var _a;
+        (_a = __classPrivateFieldGet(this, _ToolTipElement_abortController, "f")) === null || _a === void 0 ? void 0 : _a.abort();
+    }
+    handleEvent(event) {
+        if (!this.control)
+            return;
+        // Ensures that tooltip stays open when hovering between tooltip and element
+        // WCAG Success Criterion 1.4.13 Hoverable
+        if ((event.type === 'mouseenter' || event.type === 'focus') && this.hidden) {
+            this.hidden = false;
+        }
+        else if (event.type === 'blur') {
+            this.hidden = true;
+        }
+        else if (event.type === 'mouseleave' &&
+            event.relatedTarget !== this.control &&
+            event.relatedTarget !== this) {
+            this.hidden = true;
+        }
+        else if (event.type === 'keydown' && event.key === 'Escape' && !this.hidden) {
+            this.hidden = true;
+        }
+    }
+    attributeChangedCallback(name) {
+        if (name === 'id' || name === 'data-type') {
+            if (!this.id || !this.control)
+                return;
+            if (this.type === 'label') {
+                this.control.setAttribute('aria-labelledby', this.id);
+                this.setAttribute('aria-hidden', 'true');
+            }
+            else {
+                let describedBy = this.control.getAttribute('aria-describedby');
+                describedBy ? (describedBy = `${describedBy} ${this.id}`) : (describedBy = this.id);
+                this.control.setAttribute('aria-describedby', describedBy);
+            }
+        }
+        else if (this.isConnected && name === 'hidden') {
+            __classPrivateFieldGet(this, _ToolTipElement_instances, "m", _ToolTipElement_update).call(this);
+        }
+        else if (name === 'data-direction') {
+            this.classList.remove(...DIRECTION_CLASSES);
+            const direction = this.direction;
+            if (direction === 'n') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'center', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-top', "f");
+            }
+            else if (direction === 'ne') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'start', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-top', "f");
+            }
+            else if (direction === 'e') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'center', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-right', "f");
+            }
+            else if (direction === 'se') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'start', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-bottom', "f");
+            }
+            else if (direction === 's') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'center', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-bottom', "f");
+            }
+            else if (direction === 'sw') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'end', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-bottom', "f");
+            }
+            else if (direction === 'w') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'center', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-left', "f");
+            }
+            else if (direction === 'nw') {
+                __classPrivateFieldSet(this, _ToolTipElement_align, 'end', "f");
+                __classPrivateFieldSet(this, _ToolTipElement_side, 'outside-top', "f");
+            }
+        }
+    }
+}
+_ToolTipElement_abortController = new WeakMap(), _ToolTipElement_align = new WeakMap(), _ToolTipElement_side = new WeakMap(), _ToolTipElement_allowUpdatePosition = new WeakMap(), _ToolTipElement_instances = new WeakSet(), _ToolTipElement_update = function _ToolTipElement_update() {
+    if (this.hidden) {
+        this.classList.remove(TOOLTIP_OPEN_CLASS, ...DIRECTION_CLASSES);
+    }
+    else {
+        this.classList.add(TOOLTIP_OPEN_CLASS);
+        for (const tooltip of this.ownerDocument.querySelectorAll(this.tagName)) {
+            if (tooltip !== this)
+                tooltip.hidden = true;
+        }
+        __classPrivateFieldGet(this, _ToolTipElement_instances, "m", _ToolTipElement_updatePosition).call(this);
+    }
+}, _ToolTipElement_updatePosition = function _ToolTipElement_updatePosition() {
+    if (!this.control)
+        return;
+    if (!__classPrivateFieldGet(this, _ToolTipElement_allowUpdatePosition, "f") || this.hidden)
+        return;
+    const TOOLTIP_OFFSET = 10;
+    this.style.left = `0px`; // Ensures we have reliable tooltip width in `getAnchoredPosition`
+    const position = getAnchoredPosition(this, this.control, {
+        side: __classPrivateFieldGet(this, _ToolTipElement_side, "f"),
+        align: __classPrivateFieldGet(this, _ToolTipElement_align, "f"),
+        anchorOffset: TOOLTIP_OFFSET
+    });
+    const anchorSide = position.anchorSide;
+    const align = position.anchorAlign;
+    this.style.top = `${position.top}px`;
+    this.style.left = `${position.left}px`;
+    let direction = 's';
+    if (anchorSide === 'outside-left') {
+        direction = 'w';
+    }
+    else if (anchorSide === 'outside-right') {
+        direction = 'e';
+    }
+    else if (anchorSide === 'outside-top') {
+        if (align === 'center') {
+            direction = 'n';
+        }
+        else if (align === 'start') {
+            direction = 'ne';
+        }
+        else {
+            direction = 'nw';
+        }
+    }
+    else {
+        if (align === 'center') {
+            direction = 's';
+        }
+        else if (align === 'start') {
+            direction = 'se';
+        }
+        else {
+            direction = 'sw';
+        }
+    }
+    this.classList.add(`tooltip-${direction}`);
+};
+ToolTipElement.observedAttributes = ['data-type', 'data-direction', 'id', 'hidden'];
+if (!window.customElements.get('tool-tip')) {
+    window.ToolTipElement = ToolTipElement;
+    window.customElements.define('tool-tip', ToolTipElement);
+}

package/app/components/primer/clipboard_copy_component.d.ts

@@ -0,0 +1 @@
+import '@github/clipboard-copy-element';

package/app/components/primer/clipboard_copy_component.js

@@ -0,0 +1,43 @@
+import '@github/clipboard-copy-element';
+const CLIPBOARD_COPY_TIMER_DURATION = 2000;
+function showSVG(svg) {
+    svg.style.display = 'inline-block';
+}
+function hideSVG(svg) {
+    svg.style.display = 'none';
+}
+// Toggle a copy button.
+function showCopy(button) {
+    const [copyIcon, checkIcon] = button.querySelectorAll('.octicon');
+    if (!copyIcon || !checkIcon)
+        return;
+    showSVG(copyIcon);
+    hideSVG(checkIcon);
+}
+// Toggle a copy button.
+function showCheck(button) {
+    const [copyIcon, checkIcon] = button.querySelectorAll('.octicon');
+    if (!copyIcon || !checkIcon)
+        return;
+    hideSVG(copyIcon);
+    showSVG(checkIcon);
+}
+const clipboardCopyElementTimers = new WeakMap();
+document.addEventListener('clipboard-copy', function ({ target }) {
+    if (!(target instanceof HTMLElement))
+        return;
+    if (!target.hasAttribute('data-view-component'))
+        return;
+    const currentTimeout = clipboardCopyElementTimers.get(target);
+    if (currentTimeout) {
+        clearTimeout(currentTimeout);
+        clipboardCopyElementTimers.delete(target);
+    }
+    else {
+        showCheck(target);
+    }
+    clipboardCopyElementTimers.set(target, setTimeout(() => {
+        showCopy(target);
+        clipboardCopyElementTimers.delete(target);
+    }, CLIPBOARD_COPY_TIMER_DURATION));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/view-components",
-  "version": "0.0.100",
+  "version": "0.0.102",
   "description": "ViewComponents for the Primer Design System",
   "main": "app/assets/javascripts/primer_view_components.js",
   "module": "app/components/primer/primer.js",
@@ -31,8 +31,11 @@
     "build:docs": "npm run --prefix ./docs/ build",
     "build:docs:preview": "cd docs && npx gatsby build",
     "prepare": "rm -rf docs/static && mkdir -p docs/static && npm run build:js && npm run build:css && cp app/assets/**/primer_view_components.* docs/static/",
-    "lint": "eslint 'app/components/**/*.ts'",
-    "lint:fix": "eslint 'app/components/**/*.ts' --fix",
+    "lint": "npm run lint:stylelint && npm run lint:eslint",
+    "lint:stylelint": "stylelint 'app/components/**/*.pcss'",
+    "lint:stylelint:fix": "stylelint 'app/components/**/*.pcss' --fix",
+    "lint:eslint": "eslint 'app/components/**/*.ts'",
+    "lint:eslint:fix": "eslint 'app/components/**/*.ts' --fix",
     "changeset:version": "changeset version && script/version",
     "build:js": "tsc && rollup -c",
     "build:css": "postcss -o app/assets/styles/primer_view_components.css app/components/primer/primer.pcss"
@@ -74,6 +77,9 @@
     "prettier": "2.7.1",
     "rollup": "^2.77.1",
     "rollup-plugin-terser": "^7.0.2",
+    "stylelint": "^14.13.0",
+    "stylelint-config-prettier": "^9.0.3",
+    "stylelint-config-standard": "^28.0.0",
     "tslib": "^2.4.0",
     "typescript": "^4.7.4"
   },

package/static/arguments.json

@@ -123,6 +123,12 @@
         "default": "`nil`",
         "description": "CSS classes that will be added to the label."
       },
+      {
+        "name": "content_arguments",
+        "type": "Hash",
+        "default": "`{}`",
+        "description": "[System arguments](/system-arguments) used to construct the item's anchor or span tag."
+      },
       {
         "name": "truncate_label",
         "type": "Boolean",
@@ -1553,66 +1559,6 @@
       }
     ]
   },
-  {
-    "component": "Flex",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/flex_component.rb",
-    "parameters": [
-      {
-        "name": "justify_content",
-        "type": "Symbol",
-        "default": "`JUSTIFY_CONTENT_DEFAULT`",
-        "description": "Use this param to distribute space between and around flex items along the main axis of the container. One of `nil`, `:center`, `:flex_end`, `:flex_start`, `:space_around`, or `:space_between`."
-      },
-      {
-        "name": "inline",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Defaults to false."
-      },
-      {
-        "name": "flex_wrap",
-        "type": "Boolean",
-        "default": "`FLEX_WRAP_DEFAULT`",
-        "description": "Defaults to nil."
-      },
-      {
-        "name": "align_items",
-        "type": "Symbol",
-        "default": "`ALIGN_ITEMS_DEFAULT`",
-        "description": "Use this param to align items on the cross axis. One of `nil`, `:baseline`, `:center`, `:end`, `:start`, or `:stretch`."
-      },
-      {
-        "name": "direction",
-        "type": "Symbol",
-        "default": "`nil`",
-        "description": "Use this param to define the orientation of the main axis (row or column). By default, flex items will display in a row. One of `nil`, `:column`, `:column_reverse`, `:row`, or `:row_reverse`."
-      },
-      {
-        "name": "system_arguments",
-        "type": "Hash",
-        "default": "N/A",
-        "description": "[System arguments](/system-arguments)"
-      }
-    ]
-  },
-  {
-    "component": "FlexItem",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/flex_item_component.rb",
-    "parameters": [
-      {
-        "name": "flex_auto",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Fills available space and auto-sizes based on the content. Defaults to false"
-      },
-      {
-        "name": "system_arguments",
-        "type": "Hash",
-        "default": "N/A",
-        "description": "[System arguments](/system-arguments)"
-      }
-    ]
-  },
   {
     "component": "HellipButton",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/hellip_button.rb",

package/static/audited_at.json

@@ -60,8 +60,6 @@
   "Primer::Dropdown::Menu": "",
   "Primer::Dropdown::Menu::Item": "",
   "Primer::DropdownMenuComponent": "",
-  "Primer::FlexComponent": "",
-  "Primer::FlexItemComponent": "",
   "Primer::HeadingComponent": "",
   "Primer::HellipButton": "",
   "Primer::HiddenTextExpander": "",

package/static/constants.json

@@ -671,66 +671,6 @@
       "dark": "dropdown-menu-dark"
     }
   },
-  "Primer::FlexComponent": {
-    "ALIGN_ITEMS_DEFAULT": null,
-    "ALIGN_ITEMS_MAPPINGS": {
-      "start": "flex-items-start",
-      "end": "flex-items-end",
-      "center": "flex-items-center",
-      "baseline": "flex-items-baseline",
-      "stretch": "flex-items-stretch"
-    },
-    "ALIGN_ITEMS_OPTIONS": [
-      null,
-      "start",
-      "end",
-      "center",
-      "baseline",
-      "stretch"
-    ],
-    "ALLOWED_DIRECTIONS": [
-      null,
-      "column",
-      "column_reverse",
-      "row",
-      "row_reverse"
-    ],
-    "DEFAULT_DIRECTION": null,
-    "FLEX_WRAP_DEFAULT": null,
-    "FLEX_WRAP_OPTIONS": [
-      null,
-      true,
-      false
-    ],
-    "INLINE_DEFAULT": false,
-    "INLINE_OPTIONS": [
-      false,
-      true
-    ],
-    "JUSTIFY_CONTENT_DEFAULT": null,
-    "JUSTIFY_CONTENT_MAPPINGS": {
-      "flex_start": "flex-justify-start",
-      "flex_end": "flex-justify-end",
-      "center": "flex-justify-center",
-      "space_between": "flex-justify-between",
-      "space_around": "flex-justify-around"
-    },
-    "JUSTIFY_CONTENT_OPTIONS": [
-      null,
-      "flex_start",
-      "flex_end",
-      "center",
-      "space_between",
-      "space_around"
-    ]
-  },
-  "Primer::FlexItemComponent": {
-    "FLEX_AUTO_ALLOWED_VALUES": [
-      false,
-      true
-    ],
-    "FLEX_AUTO_DEFAULT": false
-  },
   "Primer::HeadingComponent": {
   },
   "Primer::HellipButton": {

package/static/statuses.json

@@ -60,8 +60,6 @@
   "Primer::Dropdown::Menu": "alpha",
   "Primer::Dropdown::Menu::Item": "alpha",
   "Primer::DropdownMenuComponent": "deprecated",
-  "Primer::FlexComponent": "deprecated",
-  "Primer::FlexItemComponent": "deprecated",
   "Primer::HeadingComponent": "deprecated",
   "Primer::HellipButton": "alpha",
   "Primer::HiddenTextExpander": "deprecated",