@gitlab/ui 84.2.0 → 85.0.1

package/src/vendor/bootstrap-vue/src/components/pagination-nav/package.json

@@ -0,0 +1,315 @@
+{
+  "name": "@bootstrap-vue/pagination-nav",
+  "version": "1.0.0",
+  "meta": {
+    "title": "Pagination Nav",
+    "description": "Quick first, previous, next, last, and page buttons for navigation based pagination, supporting regular links or router links.",
+    "components": [
+      {
+        "component": "BPaginationNav",
+        "props": [
+          {
+            "prop": "align",
+            "description": "Alignment of the page buttons: 'start' (or 'left'), 'center', 'end' (or 'right'), or 'fill'"
+          },
+          {
+            "prop": "ariaLabel",
+            "description": "Value to place in the 'aria-label' attribute of the pagination control"
+          },
+          {
+            "prop": "baseUrl",
+            "description": "Base URL to use when auto generating page links"
+          },
+          {
+            "prop": "ellipsisClass",
+            "version": "2.3.0",
+            "description": "Class(es) to apply to the 'ellipsis' placeholders"
+          },
+          {
+            "prop": "ellipsisText",
+            "description": "Content to place in the ellipsis placeholder"
+          },
+          {
+            "prop": "firstClass",
+            "version": "2.3.0",
+            "description": "Class(es) to apply to the 'Go to first page' button"
+          },
+          {
+            "prop": "firstNumber",
+            "version": "2.3.0",
+            "description": "Display first page number instead of Goto First button"
+          },
+          {
+            "prop": "firstText",
+            "description": "Content to place in the goto first page button"
+          },
+          {
+            "prop": "hideEllipsis",
+            "description": "Do not show ellipsis buttons"
+          },
+          {
+            "prop": "hideGotoEndButtons",
+            "description": "Hides the goto first and goto last page buttons"
+          },
+          {
+            "prop": "labelFirstPage",
+            "description": "Value to place in the 'aria-label' attribute of the goto first page button"
+          },
+          {
+            "prop": "labelLastPage",
+            "description": "Value to place in the 'aria-label' attribute of the goto last page button"
+          },
+          {
+            "prop": "labelNextPage",
+            "description": "Value to place in the 'aria-label' attribute of the goto next page button"
+          },
+          {
+            "prop": "labelPage",
+            "description": "Value to place in the 'aria-label' attribute of the goto page button. Page number will be prepended automatically"
+          },
+          {
+            "prop": "labelPrevPage",
+            "description": "Value to place in the 'aria-label' attribute of the goto previous page button"
+          },
+          {
+            "prop": "lastClass",
+            "version": "2.3.0",
+            "description": "Class(es) to apply to the 'Go to last page' button"
+          },
+          {
+            "prop": "lastNumber",
+            "version": "2.3.0",
+            "description": "Display last page number instead of Goto Last button"
+          },
+          {
+            "prop": "lastText",
+            "description": "Content to place in the goto last page button"
+          },
+          {
+            "prop": "limit",
+            "description": "Maximum number of buttons to show (including ellipsis if shown, but excluding the bookend buttons)"
+          },
+          {
+            "prop": "linkGen",
+            "description": "Link generator function. See docs for details"
+          },
+          {
+            "prop": "nextClass",
+            "version": "2.3.0",
+            "description": "Class(es) to apply to the 'Go to next page' button"
+          },
+          {
+            "prop": "nextText",
+            "description": "Content to place in the goto next page button"
+          },
+          {
+            "prop": "noPageDetect",
+            "description": "Disable of auto detection of current page"
+          },
+          {
+            "prop": "numberOfPages",
+            "description": "Total number of pages"
+          },
+          {
+            "prop": "pageClass",
+            "version": "2.3.0",
+            "description": "Class(es) to apply to the 'Go to page #' buttons"
+          },
+          {
+            "prop": "pageGen",
+            "description": "Page number generator function. See docs for details"
+          },
+          {
+            "prop": "pages",
+            "description": "Array of page numbers and links"
+          },
+          {
+            "prop": "pills",
+            "version": "2.1.0",
+            "description": "Applies pill styling to the pagination buttons"
+          },
+          {
+            "prop": "prevClass",
+            "version": "2.3.0",
+            "description": "Class(es) to apply to the 'Go to previous page' button"
+          },
+          {
+            "prop": "prevText",
+            "description": "Content to place in the goto previous page button"
+          },
+          {
+            "prop": "size",
+            "description": "Size of the rendered buttons: 'sm', 'md' (default), or 'lg'"
+          },
+          {
+            "prop": "useRouter",
+            "description": "Render router-links instead of links when auto generating the page links"
+          },
+          {
+            "prop": "value",
+            "description": "Current page number, starting from 1"
+          }
+        ],
+        "events": [
+          {
+            "event": "change",
+            "description": "Emitted when page changes via user interaction",
+            "args": [
+              {
+                "arg": "page",
+                "description": "Selected page number (starting with `1`)"
+              }
+            ]
+          },
+          {
+            "event": "input",
+            "description": "Emitted when page changes via user interaction or programmatically",
+            "args": [
+              {
+                "arg": "page",
+                "description": "Selected page number (starting with `1`), or `null` if no page found"
+              }
+            ]
+          },
+          {
+            "event": "page-click",
+            "description": "Emitted when a page button was clicked. Cancelable",
+            "version": "2.17.0",
+            "args": [
+              {
+                "arg": "bvEvent",
+                "type": "BvEvent",
+                "description": "The `BvEvent` object. Call `bvEvent.preventDefault()` to cancel page selection"
+              },
+              {
+                "arg": "page",
+                "description": "Page number to select (starting with `1`)"
+              }
+            ]
+          }
+        ],
+        "slots": [
+          {
+            "name": "ellipsis-text",
+            "description": "The '...' indicator content. Not scoped"
+          },
+          {
+            "name": "first-text",
+            "description": "The \"go to first page\" button content. Optionally scoped",
+            "scope": [
+              {
+                "prop": "disabled",
+                "type": "Boolean",
+                "description": "Will be true if this button is disabled (non-clickable)"
+              },
+              {
+                "prop": "index",
+                "type": "Number",
+                "description": "Page number (indexed from 0 to numberOfPages -1)"
+              },
+              {
+                "prop": "page",
+                "type": "Number",
+                "description": "Page number (from 1 to numberOfPages)"
+              }
+            ]
+          },
+          {
+            "name": "last-text",
+            "description": "The \"go to last page\" button content. Optionally scoped",
+            "scope": [
+              {
+                "prop": "disabled",
+                "type": "Boolean",
+                "description": "Will be true if this button is disabled (non-clickable)"
+              },
+              {
+                "prop": "index",
+                "type": "Number",
+                "description": "Page number (indexed from 0 to numberOfPages -1)"
+              },
+              {
+                "prop": "page",
+                "type": "Number",
+                "description": "Page number (from 1 to numberOfPages)"
+              }
+            ]
+          },
+          {
+            "name": "next-text",
+            "description": "The \"go to next page\" button content. Optionally scoped",
+            "scope": [
+              {
+                "prop": "disabled",
+                "type": "Boolean",
+                "description": "Will be true if this button is disabled (non-clickable)"
+              },
+              {
+                "prop": "index",
+                "type": "Number",
+                "description": "Page number (indexed from 0 to numberOfPages -1)"
+              },
+              {
+                "prop": "page",
+                "type": "Number",
+                "description": "Page number (from 1 to numberOfPages)"
+              }
+            ]
+          },
+          {
+            "name": "page",
+            "description": "Page number button content. Always scoped",
+            "scope": [
+              {
+                "prop": "active",
+                "type": "Boolean",
+                "description": "If the page is the active page"
+              },
+              {
+                "prop": "content",
+                "type": "String",
+                "description": "Default button content, or the result of the page-gen function"
+              },
+              {
+                "prop": "disabled",
+                "type": "Boolean",
+                "description": "Will be true if this button is disabled (non-clickable)"
+              },
+              {
+                "prop": "index",
+                "type": "Number",
+                "description": "Page number (indexed from 0 to numberOfPages -1)"
+              },
+              {
+                "prop": "page",
+                "type": "Number",
+                "description": "Page number (from 1 to numberOfPages)"
+              }
+            ]
+          },
+          {
+            "name": "prev-text",
+            "description": "The \"go to previous page\" button content. Optionally scoped",
+            "scope": [
+              {
+                "prop": "disabled",
+                "type": "Boolean",
+                "description": "Will be true if this button is disabled (non-clickable)"
+              },
+              {
+                "prop": "index",
+                "type": "Number",
+                "description": "Page number (indexed from 0 to numberOfPages -1)"
+              },
+              {
+                "prop": "page",
+                "type": "Number",
+                "description": "Page number (from 1 to numberOfPages)"
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+}

package/src/vendor/bootstrap-vue/src/components/pagination-nav/pagination-nav.js

@@ -0,0 +1,281 @@
+import { extend } from '../../vue'
+import { NAME_PAGINATION_NAV } from '../../constants/components'
+import { IS_BROWSER } from '../../constants/env'
+import { EVENT_NAME_CHANGE, EVENT_NAME_PAGE_CLICK } from '../../constants/events'
+import {
+  PROP_TYPE_ARRAY,
+  PROP_TYPE_BOOLEAN,
+  PROP_TYPE_FUNCTION,
+  PROP_TYPE_NUMBER_STRING,
+  PROP_TYPE_STRING
+} from '../../constants/props'
+import { BvEvent } from '../../utils/bv-event.class'
+import { attemptBlur, requestAF } from '../../utils/dom'
+import { isArray, isUndefined, isObject } from '../../utils/inspect'
+import { looseEqual } from '../../utils/loose-equal'
+import { mathMax } from '../../utils/math'
+import { toInteger } from '../../utils/number'
+import { omit, sortKeys } from '../../utils/object'
+import { hasPropFunction, makeProp, makePropsConfigurable, pluckProps } from '../../utils/props'
+import { computeHref, parseQuery } from '../../utils/router'
+import { toString } from '../../utils/string'
+import { warn } from '../../utils/warn'
+import { paginationMixin, props as paginationProps } from '../../mixins/pagination'
+import { props as BLinkProps } from '../link/link'
+
+// --- Helper methods ---
+
+// Sanitize the provided number of pages (converting to a number)
+export const sanitizeNumberOfPages = value => mathMax(toInteger(value, 0), 1)
+
+// --- Props ---
+
+const linkProps = omit(BLinkProps, ['event', 'routerTag'])
+
+const props = makePropsConfigurable(
+  sortKeys({
+    ...paginationProps,
+    ...linkProps,
+    baseUrl: makeProp(PROP_TYPE_STRING, '/'),
+    linkGen: makeProp(PROP_TYPE_FUNCTION),
+    // Disable auto page number detection if `true`
+    noPageDetect: makeProp(PROP_TYPE_BOOLEAN, false),
+    numberOfPages: makeProp(
+      PROP_TYPE_NUMBER_STRING,
+      1,
+      /* istanbul ignore next */
+      value => {
+        const number = toInteger(value, 0)
+        if (number < 1) {
+          warn('Prop "number-of-pages" must be a number greater than "0"', NAME_PAGINATION_NAV)
+          return false
+        }
+        return true
+      }
+    ),
+    pageGen: makeProp(PROP_TYPE_FUNCTION),
+    // Optional array of page links
+    pages: makeProp(PROP_TYPE_ARRAY),
+    useRouter: makeProp(PROP_TYPE_BOOLEAN, false)
+  }),
+  NAME_PAGINATION_NAV
+)
+
+// --- Main component ---
+
+// @vue/component
+export const BPaginationNav = /*#__PURE__*/ extend({
+  name: NAME_PAGINATION_NAV,
+  // The render function is brought in via the pagination mixin
+  mixins: [paginationMixin],
+  props,
+  computed: {
+    // Used by render function to trigger wrapping in '<nav>' element
+    isNav() {
+      return true
+    },
+    computedValue() {
+      // Returns the value prop as a number or `null` if undefined or < 1
+      const value = toInteger(this.value, 0)
+      return value < 1 ? null : value
+    }
+  },
+  watch: {
+    numberOfPages() {
+      this.$nextTick(() => {
+        this.setNumberOfPages()
+      })
+    },
+    pages() {
+      this.$nextTick(() => {
+        this.setNumberOfPages()
+      })
+    }
+  },
+  created() {
+    this.setNumberOfPages()
+  },
+  mounted() {
+    if (this.$router) {
+      // We only add the watcher if vue router is detected
+      this.$watch('$route', () => {
+        this.$nextTick(() => {
+          requestAF(() => {
+            this.guessCurrentPage()
+          })
+        })
+      })
+    }
+  },
+  methods: {
+    setNumberOfPages() {
+      if (isArray(this.pages) && this.pages.length > 0) {
+        this.localNumberOfPages = this.pages.length
+      } else {
+        this.localNumberOfPages = sanitizeNumberOfPages(this.numberOfPages)
+      }
+      this.$nextTick(() => {
+        this.guessCurrentPage()
+      })
+    },
+    onClick(event, pageNumber) {
+      // Dont do anything if clicking the current active page
+      if (pageNumber === this.currentPage) {
+        return
+      }
+
+      const target = event.currentTarget || event.target
+
+      // Emit a user-cancelable `page-click` event
+      const clickEvent = new BvEvent(EVENT_NAME_PAGE_CLICK, {
+        cancelable: true,
+        vueTarget: this,
+        target
+      })
+      this.$emit(clickEvent.type, clickEvent, pageNumber)
+      if (clickEvent.defaultPrevented) {
+        return
+      }
+
+      // Update the `v-model`
+      // Done in in requestAF() to allow browser to complete the
+      // native browser click handling of a link
+      requestAF(() => {
+        this.currentPage = pageNumber
+        this.$emit(EVENT_NAME_CHANGE, pageNumber)
+      })
+
+      // Emulate native link click page reloading behaviour by blurring the
+      // paginator and returning focus to the document
+      // Done in a `nextTick()` to ensure rendering complete
+      this.$nextTick(() => {
+        attemptBlur(target)
+      })
+    },
+    getPageInfo(pageNumber) {
+      if (
+        !isArray(this.pages) ||
+        this.pages.length === 0 ||
+        isUndefined(this.pages[pageNumber - 1])
+      ) {
+        const link = `${this.baseUrl}${pageNumber}`
+        return {
+          link: this.useRouter ? { path: link } : link,
+          text: toString(pageNumber)
+        }
+      }
+      const info = this.pages[pageNumber - 1]
+      if (isObject(info)) {
+        const link = info.link
+        return {
+          // Normalize link for router use
+          link: isObject(link) ? link : this.useRouter ? { path: link } : link,
+          // Make sure text has a value
+          text: toString(info.text || pageNumber)
+        }
+      } else {
+        return { link: toString(info), text: toString(pageNumber) }
+      }
+    },
+    makePage(pageNumber) {
+      const { pageGen } = this
+      const info = this.getPageInfo(pageNumber)
+      if (hasPropFunction(pageGen)) {
+        return pageGen(pageNumber, info)
+      }
+      return info.text
+    },
+    makeLink(pageNumber) {
+      const { linkGen } = this
+      const info = this.getPageInfo(pageNumber)
+      if (hasPropFunction(linkGen)) {
+        return linkGen(pageNumber, info)
+      }
+      return info.link
+    },
+    linkProps(pageNumber) {
+      const props = pluckProps(linkProps, this)
+      const link = this.makeLink(pageNumber)
+      if (this.useRouter || isObject(link)) {
+        props.to = link
+      } else {
+        props.href = link
+      }
+      return props
+    },
+    resolveLink(to = '') {
+      // Given a to (or href string), convert to normalized route-like structure
+      // Works only client side!
+      let link
+      try {
+        // Convert the `to` to a HREF via a temporary `a` tag
+        link = document.createElement('a')
+        link.href = computeHref({ to }, 'a', '/', '/')
+        // We need to add the anchor to the document to make sure the
+        // `pathname` is correctly detected in any browser (i.e. IE)
+        document.body.appendChild(link)
+        // Once href is assigned, the link will be normalized to the full URL bits
+        const { pathname, hash, search } = link
+        // Remove link from document
+        document.body.removeChild(link)
+        // Return the location in a route-like object
+        return { path: pathname, hash, query: parseQuery(search) }
+      } catch (e) {
+        /* istanbul ignore next */
+        try {
+          link && link.parentNode && link.parentNode.removeChild(link)
+        } catch {}
+        /* istanbul ignore next */
+        return {}
+      }
+    },
+    resolveRoute(to = '') {
+      // Given a to (or href string), convert to normalized route location structure
+      // Works only when router available!
+      try {
+        const route = this.$router.resolve(to, this.$route).route
+        return { path: route.path, hash: route.hash, query: route.query }
+      } catch (e) {
+        /* istanbul ignore next */
+        return {}
+      }
+    },
+    guessCurrentPage() {
+      const { $router, $route } = this
+      let guess = this.computedValue
+      // This section only occurs if we are client side, or server-side with `$router`
+      if (!this.noPageDetect && !guess && (IS_BROWSER || (!IS_BROWSER && $router))) {
+        // Current route (if router available)
+        const currentRoute =
+          $router && $route ? { path: $route.path, hash: $route.hash, query: $route.query } : {}
+        // Current page full HREF (if client side)
+        // Can't be done as a computed prop!
+        const loc = IS_BROWSER ? window.location || document.location : null
+        const currentLink = loc
+          ? { path: loc.pathname, hash: loc.hash, query: parseQuery(loc.search) }
+          : /* istanbul ignore next */ {}
+        // Loop through the possible pages looking for a match until found
+        for (let pageNumber = 1; !guess && pageNumber <= this.localNumberOfPages; pageNumber++) {
+          const to = this.makeLink(pageNumber)
+          if ($router && (isObject(to) || this.useRouter)) {
+            // Resolve the page via the `$router`
+            guess = looseEqual(this.resolveRoute(to), currentRoute) ? pageNumber : null
+          } else if (IS_BROWSER) {
+            // If no `$router` available (or `!this.useRouter` when `to` is a string)
+            // we compare using parsed URIs
+            guess = looseEqual(this.resolveLink(to), currentLink) ? pageNumber : null
+          } else {
+            // Probably SSR, but no `$router` so we can't guess,
+            // so lets break out of the loop early
+            /* istanbul ignore next */
+            guess = -1
+          }
+        }
+      }
+      // We set `currentPage` to `0` to trigger an `$emit('input', null)`
+      // As the default for `currentPage` is `-1` when no value is specified
+      // Valid page numbers are greater than `0`
+      this.currentPage = guess > 0 ? guess : 0
+    }
+  }
+})