@gitlab/duo-ui 0.1.0 → 0.2.0

package/src/components/utilities/friendly_wrap/friendly_wrap.md

@@ -1,66 +0,0 @@
-The friendly-wrap component lets you wrap text in a predictable way by appending [`<wbr>`] elements
-to specific break-symbols.
-
-[`<wbr>`]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/wbr
-
-## Internet Explorer 11
-
-IE11 doesn't support the `<wbr>` element: <https://caniuse.com/#search=wbr>
-To use this component on IE11, you'll need some CSS to preserve its behaviour:
-
-```css
-wbr {
-  display: inline-block;
-}
-```
-
-## Usage
-
-### Default
-
-By default, `GlFriendlyWrap` wraps text with slashes (`/`) as the break-symbol, which is especially
-useful when displaying paths or URLs:
-
-```html
-<gl-friendly-wrap text="/some/file/path" />
-```
-
-The code above renders to the following HTML:
-
-```html
-<span class="text-break">/<wbr>some/<wbr>file/<wbr>path</span>
-```
-
-### Custom symbols
-
-Multiple custom break-symbols can be defined via the `GlFriendlyWrap` prop:
-
-```html
-<gl-friendly-wrap
-  :symbols="[';', '-', '.']"
-  text="some;text-that.needs;to-be.wrapped"
-/>
-```
-
-Which renders to:
-
-```html
-<span class="text-break">some;<wbr>text-<wbr>that.<wbr>needs;<wbr>to-<wbr>be.<wbr>wrapped</span>
-```
-
-### Break words
-
-Symbols can be words too:
-
-```html
-<gl-friendly-wrap
-  :symbols="['and']"
-  text="it goes on and on and on and on"
-/>
-```
-
-Which renders to:
-
-```html
-<span class="text-break">it goes on and<wbr> on and<wbr> on and<wbr> on</span>
-```

package/src/components/utilities/friendly_wrap/friendly_wrap.vue

@@ -1,33 +0,0 @@
-<script>
-import { intersperse } from '../../../utils/data_utils';
-import { splitAfterSymbols } from '../../../utils/string_utils';
-
-export default {
-  name: 'GlFriendlyWrap',
-  functional: true,
-  props: {
-    /**
-     * Text to be wrapped.
-     */
-    text: {
-      type: String,
-      required: true,
-    },
-    /**
-     * A list of strings representing the break-words.
-     */
-    symbols: {
-      type: Array,
-      required: false,
-      default: () => ['/'],
-    },
-  },
-  render(createElement, { props }) {
-    const { symbols, text } = props;
-    const textParts = splitAfterSymbols(symbols, text ?? '');
-    const content = intersperse(() => createElement('wbr'), textParts);
-
-    return createElement('span', { class: 'text-break' }, content);
-  },
-};
-</script>

package/src/components/utilities/intersection_observer/intersection_observer.md

@@ -1,16 +0,0 @@
-This intersection observer component is an invisible watcher that emits events when it appears and
-dissapears from view.
-
-It acts a a vue-friendly wrapper around the [intersection observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API).
-
-Because of it's simplicity you can use it for a lot of different things.
-It's especially helpful for the lazy loading of images, and infinite scrolling of lists.
-
-Anything slotted inside this component will become the element that is being observed.
-
-This slot can also be used as a fallback for the browsers that don't support the intersection
-observer, or in the case that the observer fails to work.
-For example, adding a "Fetch more posts" button inside an observer that should fetch more posts
-automatically when visible. If the observer fails to work for any reason, the button will still be
-clickable, and the experience preserved. Please use a fallback wherever possible as
-**the intersection observer API is not supported in IE11**.

package/src/components/utilities/intersection_observer/intersection_observer.vue

@@ -1,67 +0,0 @@
-<script>
-import memoize from 'lodash/memoize';
-
-const getObserver = memoize(
-  (options) =>
-    new IntersectionObserver((entries) => {
-      entries.forEach((entry) => {
-        entry.target.$_gl_intersectionHandler(entry);
-      });
-    }, options || {})
-);
-
-export default {
-  name: 'GlIntersectionObserver',
-  props: {
-    /**
-     * Extra options to pass directly to the intersection observer API.
-     */
-    options: {
-      type: Object,
-      required: false,
-      default: null,
-    },
-  },
-  mounted() {
-    const observer = getObserver(this.options);
-
-    this.$el.$_gl_intersectionHandler = (entry) => {
-      /**
-       * Emitted when the element's visibility changes
-       */
-      this.$emit('update', entry);
-
-      if (entry.isIntersecting) {
-        /**
-         * Emitted when the element appears on the page
-         */
-        this.$emit('appear');
-      } else {
-        /**
-         * Emitted when the element disappears from the page
-         */
-        this.$emit('disappear');
-      }
-    };
-    this.$el.$_gl_intersectionObserver = observer;
-
-    observer.observe(this.$el);
-  },
-  destroyed() {
-    this.$el.$_gl_intersectionObserver.unobserve(this.$el);
-    delete this.$el.$_gl_intersectionHandler;
-    delete this.$el.$_gl_intersectionObserver;
-  },
-  // Expose getObserver method for tests
-  getObserver,
-};
-</script>
-
-<template>
-  <div>
-    <!--
-    @slot The element you wish to observe, or a fallback if the observer doesn't work.
-    -->
-    <slot></slot>
-  </div>
-</template>

package/src/components/utilities/intersperse/intersperse.md

@@ -1,90 +0,0 @@
-The intersperse component separates a list of elements
-by a given character (the default is `, `).
-
-It takes all direct descendants of its default slot and inserts
-the given separator between each item:
-
-`item 1, item 2, item 3`
-
-Optionally the character used for separating each item and the last separator can be set
-independently:
-
-* `separator="/"`  renders `item 1/item 2/item 3`
-* `lastSeparator=" and "` will render `item 1, item 2, and item 3`
-* `lastSeparator=" and "` and given two items will render `item 1 and item 2`
-
-**Note**:
-
-The component provides an inline context since the result is wrapped in a `span`.
-
-Also, whitespace elements that are direct children of the default-slot get removed to ensure
-consistent formatting.
-
-## Usage
-
-### Default
-
-```html
-<gl-intersperse>
-    <span>Item 1</span>
-    <span>Item 2</span>
-    <span>Item 3</span>
-</gl-intersperse>
-```
-
-This renders to the following HTML:
-
-```html
-<span><span>Item 1</span>, <span>Item 2</span>, <span>Item 3</span></span>
-```
-
-### Custom Separator
-
-A custom separator can be defined via the `separator` prop:
-
-```html
-<gl-intersperse separator="/">
-    <span>Item 1</span>
-    <span>Item 2</span>
-    <span>Item 3</span>
-</gl-intersperse>
-```
-
-This renders to the following HTML:
-
-```html
-<span><span>Item 1</span>/<span>Item 2</span>/<span>Item 3</span></span>
-```
-
-### Custom Last Separator
-
-A custom last separator can be defined via the `lastSeparator` prop:
-
-```html
-<gl-intersperse last-separator=" and ">
-    <span>Item 1</span>
-    <span>Item 2</span>
-    <span>Item 3</span>
-</gl-intersperse>
-```
-
-This renders to the following HTML:
-
-```html
-<span><span>Item 1</span>, <span>Item 2</span>, and <span>Item 3</span></span>
-```
-
-A custom last separator used on two items will only place `lastSeparator` between them:
-
-```html
-<gl-intersperse last-separator=" and ">
-    <span>Item 1</span>
-    <span>Item 2</span>
-</gl-intersperse>
-```
-
-This renders to the following HTML:
-
-```html
-<span><span>Item 1</span> and <span>Item 2</span></span>
-```

package/src/components/utilities/intersperse/intersperse.vue

@@ -1,60 +0,0 @@
-<!-- eslint-disable vue/multi-word-component-names -->
-<script>
-import compose from 'lodash/fp/compose';
-import fill from 'lodash/fp/fill';
-import filter from 'lodash/fp/filter';
-
-import { intersperse, insert } from '../../../utils/data_utils';
-
-const containsWhitespaceOnly = (vNode) => vNode.text.trim() === '';
-const isTag = (vNode) => typeof vNode.tag === 'string';
-const filterWhitespaceNodes = filter((vNode) => isTag(vNode) || !containsWhitespaceOnly(vNode));
-
-const insertAfterSecondLastItem = insert(-1);
-const replaceSecondLastItem = fill(-2, -1);
-
-// handles the addition of the lastSeparator in these two cases:
-// item1, item2, item3 => item1, item2, and item3
-// item1, item2 => item1 and item2
-const addLastSeparator = (lastSeparator) => (items) => {
-  if (!lastSeparator) {
-    return items;
-  }
-
-  return items.length > 3
-    ? insertAfterSecondLastItem(lastSeparator, items)
-    : replaceSecondLastItem(lastSeparator, items);
-};
-
-export default {
-  name: 'GlIntersperse',
-  functional: true,
-  props: {
-    separator: {
-      type: String,
-      default: ', ',
-      required: false,
-    },
-    lastSeparator: {
-      type: String,
-      default: '',
-      required: false,
-    },
-  },
-  render(createElement, context) {
-    const {
-      props: { separator, lastSeparator },
-      slots,
-      data,
-    } = context;
-
-    const filterAndSeparate = compose(
-      addLastSeparator(lastSeparator),
-      intersperse(separator),
-      filterWhitespaceNodes
-    );
-
-    return createElement('span', data, filterAndSeparate(slots().default));
-  },
-};
-</script>

package/src/components/utilities/sprintf/sprintf.md

@@ -1,243 +0,0 @@
-## Overview
-
-The `GlSprintf` component lets you do `sprintf`-style string interpolation with
-child components. Each placeholder in the translated string, provided via the
-`message` prop, becomes a slot that you can use to insert any components or
-markup in the rendered output.
-
-> NOTE: `gl-sprintf` does not translate the message for you; you must provide
-> it already translated. In the following examples, it is assumed that
-> a `gettext`-style `__` translation function is available in your Vue
-> templates.
-
-## Displaying messages with text between placeholders (e.g., links, buttons)
-
-Sentences should not be split up into different messages, otherwise they may
-not be translatable into certain languages. To help with this, `GlSprintf`
-interprets placeholders suffixed with `Start` and `End` to indicate the
-boundaries of a component to display within the message. Any text between
-them is passed, via the `content` scoped slot property, to the slot name common
-to the placeholders.
-
-For example, using `linkStart` and `linkEnd` placeholders in a message defines
-a `link` scoped slot:
-
-```html
-<div>
-  <gl-sprintf :message="__('Learn more about %{linkStart}zones%{linkEnd}')">
-    <template #link="{ content }">
-      <gl-link
-        href="https://cloud.google.com/compute/docs/regions-zones/regions-zones"
-        target="_blank"
-      >{{ content }}</gl-link>
-    </template>
-  </gl-sprintf>
-</div>
-```
-
-will render as:
-
-```html
-<div>
-  Learn more about
-  <a
-    href="https://cloud.google.com/compute/docs/regions-zones/regions-zones"
-    target="_blank"
-    rel="noopener noreferrer"
-  >zones</a>
-</div>
-```
-
-Note that _any_ arbitrary HTML tags or Vue component(s) can be used within
-a scoped slot, and that the content passed to it can be used in any way at all;
-for instance, as regular text, or in component attributes or slots.
-
-Here's a more complex example, which `<gl-sprintf>` lets you do in a breeze:
-
-```html
-<div>
-  <gl-sprintf :message="__('Written by %{authorStart}someone%{authorEnd}')">
-    <template #author="{ content }">
-      <my-vue-component v-gl-tooltip="content" @event="handleEvent(content)">
-        {{ content }}
-      </my-vue-component>
-      <p>
-          {{ content }}
-          <div>{{ content }}</div>
-      </p>
-    </template>
-  </gl-sprintf>
-</div>
-```
-
-This is not feasible in a JS-only solution, since arbitrary Vue components
-cannot easily be used. In addition, a JS-only solution is more likely to be
-prone to XSS attacks, as the Vue compiler isn't available to help protect
-against them.
-
-### Customizing start/end placeholders
-
-You can customize the start and end placeholders that `GlSprintf` looks for
-using the `placeholders` prop. For instance:
-
-```html
-<div>
-  <gl-sprintf
-    :message="__('Learn more about %{my_custom_start}zones%{my_custom_end}')"
-    :placeholders="{ link: ['my_custom_start', 'my_custom_end'] }"
-  >
-    <template #link="{ content }">
-      <gl-link
-        href="https://cloud.google.com/compute/docs/regions-zones/regions-zones"
-        target="_blank"
-      >{{ content }}</gl-link>
-    </template>
-  </gl-sprintf>
-</div>
-```
-
-This can be useful if you are migrating an existing string to `GlSprintf` that
-uses different placeholder naming conventions, and don't want invalidate
-existing translations.
-
-## Displaying components within a message
-
-Use slots to replace placeholders in the message with the slots' contents.
-There is a slot for every placeholder in the message. For example, the `author`
-slot name can be used when there is an `%{author}` placeholder in the message:
-
-```html
-<script>
-export default {
-  data() {
-    return {
-      authorName: 'Some author',
-    };
-  },
-};
-</script>
-
-<template>
-  <div>
-    <gl-sprintf :message="__('Written by %{author}')">
-      <template #author>
-        <span>{{ authorName }}</span>
-      </template>
-    </gl-sprintf>
-  </div>
-</template>
-```
-
-The example above renders to this HTML:
-
-```html
-<div>Written by <span>Some author</span></div>
-```
-
-## Usage caveats
-
-### White space
-
-`GlSprintf` does not handle white space in scoped slots specially; it is passed
-through and rendered just like regular text. This means that white space in the
-scoped slot templates *themselves*, including newlines and indentation, are
-passed through untouched (assuming the template compiler you're using doesn't
-trim text nodes at compile time; `vue-template-compiler` preserves white space
-by default, for instance).
-
-Most of the time you don't need to worry about this, since
-[browsers normalize white space][1] automatically, but here's an example, using
-punctuation, where you might want to be conscious of the white space in the
-template:
-
-```html
-<div>
-  <gl-sprintf :message="__('Foo %{boldStart}bar%{boldEnd}!')">
-    <template #bold="{ content }">
-      <b>
-        {{ content }}
-      </b>
-    </template>
-  </gl-sprintf>
-</div>
-```
-
-As written, the literal markup rendered would be:
-
-```html
-<div>  Foo <b>
-        bar
-      </b>!
-</div>
-```
-
-where the white space (including newlines) before and after `bar` is exactly
-the newlines and indentation in the source template. The browser will render
-this as:
-
-<div>  Foo <b>
-        bar
-      </b>!
-</div>
-
-Note the single space between `bar` and `!`. To avoid that, remove the
-white space in the template, or use `v-text`:
-
-```html
-<div>
-  <gl-sprintf :message="__('Foo %{boldStart}bar%{boldEnd}!')">
-    <template #bold="{ content }">
-      <b>{{ content }}</b>
-      <!-- OR -->
-      <b v-text="content" />
-    </template>
-  </gl-sprintf>
-</div>
-```
-
-### Miscellaneous
-
-While there are a lot of caveats here, you don't need to worry about reading
-them _unless_ you find `GlSprintf` isn't rendering what you'd expect.
-
-- Since `GlSprintf` typically renders multiple elements, it can't be used as
-  a component's root, it must be wrapped with at least one other root element,
-  otherwise Vue will throw a `Multiple root nodes returned from render
-  function` error.
-- If a slot for a given placeholder _isn't_ provided, the placeholder
-  will be rendered as-is, e.g., literally `Written by %{author}` if the
-  `author` slot _isn't_ provided, or literally `%{linkStart}foo%{linkEnd}` if
-  the `link` slot isn't provided.
-- Content between `Start` and `End` placeholders is effectively thrown away if
-  the scoped slot of the correct name doesn't consume the `content` property in
-  some way, though the slot's components should still be rendered.
-- If there's no placeholder in the message for a provided named slot, the
-  content of that slot is silently thrown away.
-- If only one of the `Start` or `End` placeholders is in the message, or they
-  are in the wrong order, they are treated as plain slots, i.e., it is assumed
-  there is no text to extract and pass to the scoped slot. This allows you to
-  use plain slots whose names end in `Start` or `End`, e.g., `backEnd`, or
-  `fromStart` in isolation, without their `Start`/`End` counterparts.
-- Text extraction between `Start` and `End` placeholders is only done one level
-  deep. This is intentional, so as to avoid building complex sprintf messages
-  that would better be implemented in components. As an example,
-  `${linkStart}test%{icon}%{linkEnd}`, if provided both the `link` and `icon`
-  slots, would pass `test%{icon}` as a literal string as content to the `link`
-  scoped slot.
-- For more examples and edge cases, please see the test suite for `GlSprintf`.
-- To be successfully used in `GlSprintf`, slot names should:
-  - start with a letter (`[A-Za-z]`)
-  - only contain alpha-numeric characters (`[A-Za-z0-9]`), underscore (`_`) and
-    dash (`-`),
-  - should not end with underscore (`_`) or dash (`-`) So for example:
-    `%{author}`, `%{author_name}`, `%{authorName}` or `%{author-name-100}` are
-    all valid placeholders.
-
-## Internet Explorer 11
-
-This component uses [`String.prototype.startsWith()`] and [`String.prototype.endsWith()`] under the
-hood. Make sure those methods are polyfilled if you plan on using the component on IE11.
-
-[1]: https://www.w3.org/TR/css-text-3/#white-space-phase-1
-[`String.prototype.startsWith()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
-[`String.prototype.endsWith()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith