@gitlab/ui 86.5.1 → 86.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "86.5.1",
+  "version": "86.7.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",

package/src/components/experimental/duo/chat/components/duo_chat_conversation/duo_chat_conversation.vue

@@ -29,6 +29,13 @@ export default {
       type: Array,
       required: true,
     },
+    /**
+     * Whether the insertCode feature should be available.
+     */
+    enableCodeInsertion: {
+      type: Boolean,
+      required: true,
+    },
     /**
      * Whether to show the delimiter before this conversation
      */
@@ -46,12 +53,20 @@ export default {
        */
       this.$emit('track-feedback', event);
     },
+    onInsertCodeSnippet(e) {
+      this.$emit('insert-code-snippet', e);
+    },
   },
   i18n,
 };
 </script>
 <template>
-  <div class="gl-display-flex gl-flex-direction-column gl-justify-content-end">
+  <div
+    :class="[
+      'gl-display-flex gl-flex-direction-column gl-justify-content-end',
+      { 'insert-code-hidden': !enableCodeInsertion },
+    ]"
+  >
     <div
       v-if="showDelimiter"
       class="gl-my-5 gl-display-flex gl-align-items-center gl-gap-4 gl-text-gray-500"
@@ -67,6 +82,7 @@ export default {
       :message="msg"
       :is-cancelled="canceledRequestIds.includes(msg.requestId)"
       @track-feedback="onTrackFeedback"
+      @insert-code-snippet="onInsertCodeSnippet"
     />
   </div>
 </template>

package/src/components/experimental/duo/chat/components/duo_chat_message/buttons_utils.js

@@ -0,0 +1,30 @@
+import iconsPath from '@gitlab/svgs/dist/icons.svg';
+
+export const createButton = (title = 'Insert the code snippet', iconId = 'insert') => {
+  const button = document.createElement('button');
+  button.type = 'button';
+  button.classList.add(
+    'btn',
+    'btn-default',
+    'btn-md',
+    'gl-button',
+    'btn-default-secondary',
+    'btn-icon'
+  );
+  button.dataset.title = title;
+
+  // Create an SVG element with the correct namespace
+  const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
+  svg.setAttribute('role', 'img');
+  svg.setAttribute('aria-hidden', 'true');
+  svg.classList.add('gl-button-icon', 'gl-icon', 's16');
+
+  // Create a 'use' element with the correct namespace
+  const use = document.createElementNS('http://www.w3.org/2000/svg', 'use');
+  use.setAttribute('href', `${iconsPath}#${iconId}`);
+
+  svg.appendChild(use);
+  button.appendChild(svg);
+
+  return button;
+};

package/src/components/experimental/duo/chat/components/duo_chat_message/copy_code_element.js

@@ -1,38 +1,9 @@
-import iconsPath from '@gitlab/svgs/dist/icons.svg';
-
-const createButton = () => {
-  const button = document.createElement('button');
-  button.type = 'button';
-  button.classList.add(
-    'btn',
-    'btn-default',
-    'btn-md',
-    'gl-button',
-    'btn-default-secondary',
-    'btn-icon'
-  );
-  button.dataset.title = 'Copy to clipboard';
-
-  // Create an SVG element with the correct namespace
-  const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
-  svg.setAttribute('role', 'img');
-  svg.setAttribute('aria-hidden', 'true');
-  svg.classList.add('gl-button-icon', 'gl-icon', 's16');
-
-  // Create a 'use' element with the correct namespace
-  const use = document.createElementNS('http://www.w3.org/2000/svg', 'use');
-  use.setAttribute('href', `${iconsPath}#copy-to-clipboard`);
-
-  svg.appendChild(use);
-  button.appendChild(svg);
-
-  return button;
-};
+import { createButton } from './buttons_utils';
 
 export class CopyCodeElement extends HTMLElement {
   constructor() {
     super();
-    const btn = createButton();
+    const btn = createButton('Copy to clipboard', 'copy-to-clipboard');
     const wrapper = this.parentNode;
 
     this.appendChild(btn);

package/src/components/experimental/duo/chat/components/duo_chat_message/duo_chat_message.scss

@@ -21,7 +21,8 @@
     @include gl-mb-0;
   }
 
-  copy-code {
+  copy-code,
+  insert-code-snippet {
     position: absolute;
     @include gl-transition-medium;
     @include gl-opacity-0;
@@ -29,9 +30,15 @@
     top: $gl-spacing-scale-3;
   }
 
+  copy-code {
+    margin-right: $gl-spacing-scale-8;
+  }
+
   .js-markdown-code.markdown-code-block:hover {
     copy-code,
-    copy-code:focus-within {
+    copy-code:focus-within,
+    insert-code-snippet,
+    insert-code-snippet:focus-within {
       @include gl-opacity-10;
     }
   }
@@ -45,3 +52,13 @@
     position: absolute;
   }
 }
+
+.insert-code-hidden {
+  insert-code-snippet {
+    display: none;
+  }
+
+  copy-code {
+    margin-right: 0;
+  }
+}

package/src/components/experimental/duo/chat/components/duo_chat_message/duo_chat_message.vue

@@ -11,6 +11,7 @@ import DocumentationSources from '../duo_chat_message_sources/duo_chat_message_s
 // eslint-disable-next-line no-restricted-imports
 import { renderDuoChatMarkdownPreview } from '../../markdown_renderer';
 import { CopyCodeElement } from './copy_code_element';
+import { InsertCodeSnippetElement } from './insert_code_snippet_element';
 import { concatUntilEmpty } from './utils';
 
 export const i18n = {
@@ -30,7 +31,7 @@ export default {
   name: 'GlDuoChatMessage',
   i18n,
   safeHtmlConfigExtension: {
-    ADD_TAGS: ['copy-code'],
+    ADD_TAGS: ['copy-code', 'insert-code-snippet'],
   },
   components: {
     DocumentationSources,
@@ -132,6 +133,9 @@ export default {
     if (!customElements.get('copy-code')) {
       customElements.define('copy-code', CopyCodeElement);
     }
+    if (!customElements.get('insert-code-snippet')) {
+      customElements.define('insert-code-snippet', InsertCodeSnippetElement);
+    }
   },
   mounted() {
     if (this.isAssistantMessage) {
@@ -180,6 +184,9 @@ export default {
         this.stopWatchingMessage();
       }
     },
+    onInsertCodeSnippet(e) {
+      this.$emit('insert-code-snippet', e);
+    },
   },
 };
 </script>
@@ -193,6 +200,7 @@ export default {
       'gl-bg-white': isAssistantMessage && !error,
       'gl-bg-red-50 gl-border-none!': error,
     }"
+    @insert-code-snippet="onInsertCodeSnippet"
   >
     <gl-icon
       v-if="error"

package/src/components/experimental/duo/chat/components/duo_chat_message/insert_code_snippet_element.js

@@ -0,0 +1,17 @@
+import { createButton } from './buttons_utils';
+
+export class InsertCodeSnippetElement extends HTMLElement {
+  constructor(codeBlock) {
+    super();
+    const btn = createButton();
+    const wrapper = codeBlock;
+    this.appendChild(btn);
+    btn.addEventListener('click', () => {
+      if (wrapper) {
+        wrapper.dispatchEvent(
+          new CustomEvent('insert-code-snippet', { bubbles: true, cancelable: true })
+        );
+      }
+    });
+  }
+}

package/src/components/experimental/duo/chat/duo_chat.vue

@@ -116,6 +116,14 @@ export default {
       required: false,
       default: true,
     },
+    /**
+     * Whether the insertCode feature should be available.
+     */
+    enableCodeInsertion: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
     /**
      * Array of predefined prompts to display in the chat to start a conversation.
      */
@@ -403,6 +411,9 @@ export default {
         this.setPromptAndFocus(`${command.name} `);
       }
     },
+    onInsertCodeSnippet(e) {
+      this.$emit('insert-code-snippet', e);
+    },
   },
   i18n,
   emptySvg,
@@ -487,10 +498,12 @@ export default {
         <gl-duo-chat-conversation
           v-for="(conversation, index) in conversations"
           :key="`conversation-${index}`"
+          :enable-code-insertion="enableCodeInsertion"
           :messages="conversation"
           :canceled-request-ids="canceledRequestIds"
           :show-delimiter="index > 0"
           @track-feedback="onTrackFeedback"
+          @insert-code-snippet="onInsertCodeSnippet"
         />
         <template v-if="!hasMessages && !isLoading">
           <gl-empty-state

package/src/components/experimental/duo/chat/mock_data.js

@@ -1,4 +1,5 @@
 import { setStoryTimeout } from '../../../../utils/test_utils';
+import { InsertCodeSnippetElement } from './components/duo_chat_message/insert_code_snippet_element';
 import {
   DOCUMENTATION_SOURCE_TYPES,
   MESSAGE_MODEL_ROLES,
@@ -31,7 +32,7 @@ export const MOCK_RESPONSE_MESSAGE = {
   content:
     'Here is a simple JavaScript function to sum two numbers:\n\n  ```js\n  function sum(a, b) {\n    return a + b;\n  }\n  ```\n  \n  To use it:\n  \n  ```js\n  const result = sum(5, 3); // result = 8\n  ```\n  \n  This function takes two number parameters, a and b. It returns the sum of adding them together.\n',
   contentHtml:
-    '<p data-sourcepos="1:1-1:56" dir="auto">Here is a simple JavaScript function to sum two numbers:</p>\n<div class="gl-relative markdown-code-block js-markdown-code">\n<pre data-sourcepos="3:1-7:3" data-canonical-lang="js" class="code highlight js-syntax-highlight language-javascript" lang="javascript" v-pre="true"><code><span id="LC1" class="line" lang="javascript"><span class="kd">function</span> <span class="nf">sum</span><span class="p">(</span><span class="nx">a</span><span class="p">,</span> <span class="nx">b</span><span class="p">)</span> <span class="p">{</span></span>\n<span id="LC2" class="line" lang="javascript">  <span class="k">return</span> <span class="nx">a</span> <span class="o">+</span> <span class="nx">b</span><span class="p">;</span></span>\n<span id="LC3" class="line" lang="javascript"><span class="p">}</span></span></code></pre>\n<copy-code></copy-code>\n</div>\n<p data-sourcepos="9:1-9:10" dir="auto">To use it:</p>\n<div class="gl-relative markdown-code-block js-markdown-code">\n<pre data-sourcepos="11:1-13:3" data-canonical-lang="js" class="code highlight js-syntax-highlight language-javascript" lang="javascript" v-pre="true"><code><span id="LC1" class="line" lang="javascript"><span class="kd">const</span> <span class="nx">result</span> <span class="o">=</span> <span class="nf">sum</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">3</span><span class="p">);</span> <span class="c1">// result = 8</span></span></code></pre>\n<copy-code></copy-code>\n</div>\n<p data-sourcepos="15:1-15:95" dir="auto">This function takes two number parameters, a and b. It returns the sum of adding them together.</p>',
+    '<p data-sourcepos="1:1-1:56" dir="auto">Here is a simple JavaScript function to sum two numbers:</p>\n<div class="gl-relative markdown-code-block js-markdown-code">\n<pre data-sourcepos="3:1-7:3" data-canonical-lang="js" class="code highlight js-syntax-highlight language-javascript" lang="javascript" v-pre="true"><code><span id="LC1" class="line" lang="javascript"><span class="kd">function</span> <span class="nf">sum</span><span class="p">(</span><span class="nx">a</span><span class="p">,</span> <span class="nx">b</span><span class="p">)</span> <span class="p">{</span></span>\n<span id="LC2" class="line" lang="javascript">  <span class="k">return</span> <span class="nx">a</span> <span class="o">+</span> <span class="nx">b</span><span class="p">;</span></span>\n<span id="LC3" class="line" lang="javascript"><span class="p">}</span></span></code></pre>\n<copy-code></copy-code>\n<insert-code-snippet></insert-code-snippet>\n</div>\n<p data-sourcepos="9:1-9:10" dir="auto">To use it:</p>\n<div class="gl-relative markdown-code-block js-markdown-code">\n<pre data-sourcepos="11:1-13:3" data-canonical-lang="js" class="code highlight js-syntax-highlight language-javascript" lang="javascript" v-pre="true"><code><span id="LC1" class="line" lang="javascript"><span class="kd">const</span> <span class="nx">result</span> <span class="o">=</span> <span class="nf">sum</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">3</span><span class="p">);</span> <span class="c1">// result = 8</span></span></code></pre>\n<copy-code></copy-code>\n</div>\n<p data-sourcepos="15:1-15:95" dir="auto">This function takes two number parameters, a and b. It returns the sum of adding them together.</p>',
   role: MESSAGE_MODEL_ROLES.assistant,
   extras: {
     sources: MOCK_SOURCES,
@@ -137,6 +138,7 @@ export const renderGFM = (el) => {
   const codeBlock = el.querySelectorAll('.markdown-code-block');
   codeBlock.forEach((block) => {
     block?.classList.add('gl-markdown', 'gl-compact-markdown');
+    block?.appendChild(new InsertCodeSnippetElement(block));
   });
 };
 

package/src/directives/outside/outside.js

@@ -1,20 +1,29 @@
 /**
- * Map<HTMLElement, Function>
+ * Map<HTMLElement, { callback: Function, eventTypes: Array<string> }>
  */
 const callbacks = new Map();
+const click = 'click';
+const focusin = 'focusin';
+const supportedEventTypes = [click, focusin];
+const defaultEventType = click;
 
 /**
- * Is a global listener already set up?
+ * A Set to keep track of currently active event types.
+ * This ensures that event listeners are only added for the event types that are in use.
+ *
+ * @type {Set<string>}
  */
-let listening = false;
+const activeEventTypes = new Set();
 let lastMousedown = null;
 
 const globalListener = (event) => {
-  callbacks.forEach((callback, element) => {
-    const originalEvent = lastMousedown || event;
+  callbacks.forEach(({ callback, eventTypes }, element) => {
+    const originalEvent = event.type === click ? lastMousedown || event : event;
     if (
       // Ignore events that aren't targeted outside the element
-      element.contains(originalEvent.target)
+      element.contains(originalEvent.target) ||
+      // Ignore events that aren't the specified types for this element
+      !eventTypes.includes(event.type)
     ) {
       return;
     }
@@ -28,7 +37,9 @@ const globalListener = (event) => {
       }
     }
   });
-  lastMousedown = null;
+  if (event.type === click) {
+    lastMousedown = null;
+  }
 };
 
 // We need to listen for mouse events because text selection fires click event only when selection ends.
@@ -38,41 +49,73 @@ const onMousedown = (event) => {
   lastMousedown = event;
 };
 
-const startListening = () => {
-  if (listening) {
-    return;
-  }
+const startListening = (eventTypes) => {
+  eventTypes.forEach((eventType) => {
+    if (!activeEventTypes.has(eventType)) {
+      // Listening to mousedown events, ensures that a text selection doesn't trigger the
+      // GlOutsideDirective 'click' callback if the selection started within the target element.
+      if (eventType === click) {
+        document.addEventListener('mousedown', onMousedown);
+      }
+
+      // Added { capture: true } to all event types to prevent the behavior discussed in https://gitlab.com/gitlab-org/gitlab-ui/-/merge_requests/1686#note_412545027
+      // Ensures the event listener handles the event in the capturing phase, avoiding issues encountered previously.
+      // Cannot be tested with Jest or Cypress, but can be tested with Playwright in the future: https://gitlab.com/gitlab-org/gitlab-ui/-/merge_requests/4272#note_1947425384
+      document.addEventListener(eventType, globalListener, { capture: true });
+      activeEventTypes.add(eventType);
+    }
+  });
 
-  document.addEventListener('mousedown', onMousedown);
-  // Added { capture: true } to prevent the behavior discussed in https://gitlab.com/gitlab-org/gitlab-ui/-/merge_requests/1686#note_412545027
-  // Ensures the event listener handles the event in the capturing phase, avoiding issues encountered previously.
-  // Cannot be tested with Jest or Cypress, but can be tested with Playwright in the future: https://gitlab.com/gitlab-org/gitlab-ui/-/merge_requests/4272#note_1947425384
-  document.addEventListener('click', globalListener, { capture: true });
-  listening = true;
   lastMousedown = null;
 };
 
-const stopListening = () => {
-  if (!listening) {
-    return;
-  }
+const stopListening = (eventTypesToUnbind) => {
+  eventTypesToUnbind.forEach((eventType) => {
+    if (activeEventTypes.has(eventType)) {
+      if ([...callbacks.values()].every(({ eventTypes }) => !eventTypes.includes(eventType))) {
+        document.removeEventListener(eventType, globalListener);
+        activeEventTypes.delete(eventType);
+      }
+    }
+  });
 
-  document.removeEventListener('mousedown', onMousedown);
-  document.removeEventListener('click', globalListener);
-  listening = false;
+  if (eventTypesToUnbind.includes(click) && !activeEventTypes.has(click)) {
+    document.removeEventListener('mousedown', onMousedown);
+  }
 };
 
-const bind = (el, { value, arg = 'click' }) => {
-  if (typeof value !== 'function') {
-    throw new Error(`[GlOutsideDirective] Value must be a function; got ${typeof value}!`);
-  }
+function parseBinding({ arg, value, modifiers }) {
+  const modifiersList = Object.keys(modifiers);
+
+  if (process.env.NODE_ENV !== 'production') {
+    if (typeof value !== 'function') {
+      throw new Error(`[GlOutsideDirective] Value must be a function; got ${typeof value}!`);
+    }
+
+    if (typeof arg !== 'undefined') {
+      throw new Error(
+        `[GlOutsideDirective] Arguments are not supported. Consider using modifiers instead.`
+      );
+    }
 
-  if (arg !== 'click') {
-    throw new Error(
-      `[GlOutsideDirective] Cannot bind ${arg} events; only click events are currently supported!`
-    );
+    if (modifiersList.some((modifier) => !supportedEventTypes.includes(modifier))) {
+      throw new Error(
+        `[GlOutsideDirective] Cannot bind ${modifiersList} events; supported event types are: ${supportedEventTypes.join(
+          ', '
+        )}`
+      );
+    }
   }
 
+  return {
+    callback: value,
+    eventTypes: modifiersList.length > 0 ? modifiersList : [defaultEventType],
+  };
+}
+
+const bind = (el, bindings) => {
+  const { callback, eventTypes } = parseBinding(bindings);
+
   if (callbacks.has(el)) {
     // This element is already bound. This is possible if two components, which
     // share the same root node, (i.e., one is a higher-order component
@@ -86,18 +129,15 @@ const bind = (el, { value, arg = 'click' }) => {
     return;
   }
 
-  if (!listening) {
-    startListening();
-  }
-
-  callbacks.set(el, value);
+  callbacks.set(el, { callback, eventTypes });
+  startListening(eventTypes);
 };
 
 const unbind = (el) => {
-  callbacks.delete(el);
-
-  if (callbacks.size === 0) {
-    stopListening();
+  const entry = callbacks.get(el);
+  if (entry) {
+    callbacks.delete(el);
+    stopListening(entry.eventTypes);
   }
 };
 

package/src/directives/outside/outside.md

@@ -1,8 +1,14 @@
-A Vue Directive to call a callback when a click occurs *outside* of the element
-the directive is bound to. Any clicks on the element or any descendant elements are ignored.
+A Vue Directive to call a callback when a supported event type occurs *outside* of the element
+the directive is bound to. Any events on the element or any descendant elements are ignored.
+The directive supports the event types `click` and `focusin` and can be configured in several ways.
+If no event type is set, `click` is the default.
 
 ## Usage
 
+### Default
+
+The following example listens for click events outside the specified element:
+
 ```html
 <script>
 import { GlOutsideDirective as Outside } from '@gitlab/ui';
@@ -22,6 +28,51 @@ export default {
 </template>
 ```
 
+### When binding another event type than `click`
+
+You can specify event types as modifiers. The following example listens for `focusin` events,
+but not for `click`. With this implementation:
+
+```html
+<script>
+export default {
+  methods: {
+    onFocusin(event) {
+      console.log('User set the focus somewhere outside of this component', event);
+    }
+  }
+};
+</script>
+
+<template>
+  <div v-outside.focusin="onFocusin">...</div>
+</template>
+```
+
+### When binding multiple event types
+
+You can specify multiple event types by providing multiple modifiers. The following example
+listens for `click` and `focusin` events:
+
+```html
+<script>
+export default {
+  methods: {
+    onEvent(event) {
+      console.log('Event occurred outside the element:', event);
+    }
+  }
+};
+</script>
+
+<template>
+  <div v-outside.click.focusin="onEvent">...</div>
+</template>
+```
+
+💡 The callback function receives the `event` as a parameter. You can use the `event.type`
+property to execute different code paths depending on which event triggered the callback.
+
 ### When handler expects arguments
 
 In case a click handler expects an arument to be passed, simple `v-outside="onClick('foo')"` will
@@ -36,19 +87,54 @@ import { GlOutsideDirective as Outside } from '@gitlab/ui';
 export default {
   directives: { Outside },
   methods: {
-    onClick(foo) {
-      // This
+    onClick(event, foo) {
+      console.log('Event occurred outside the element:', event);
+      console.log('An argument was passed along:', foo);
     },
   },
 };
 </script>
 
 <template>
-  <div v-outside="() => onClick('foo')">Click anywhere but here</div>
+  <div v-outside="(event) => onClick(event, 'foo')">Click anywhere but here</div>
 </template>
 ```
 
 ## Caveats
 
-- Clicks cannot be detected across document boundaries (e.g., across an
+* Clicks cannot be detected across document boundaries (e.g., across an
   `iframe` boundary), in either direction.
+* Clicks on focusable elements, such as buttons or input fields, will fire both
+  `click` and `focusin` events. When both event types are registered,
+  the callback will be executed twice. To prevent executing the same code twice
+  after only one user interaction, use a flag in the callback to stop its
+  execution. Example:
+
+  ```html
+    <script>
+    export default {
+      data: () => ({
+        isOpen: false,
+      }),
+      methods: {
+        openDropdown() {
+          this.isOpen = true;
+        },
+        closeDropdown() {
+          if(!this.isOpen) {
+            return
+          }
+
+          // more code
+
+          this.isOpen = false;
+        }
+      }
+    };
+    </script>
+
+    <template>
+      <button type="button" @click="openDropdown">Open</button>
+      <div v-outside.click.focusin="closeDropdown">...</div>
+    </template>
+  ```