@algolia/satellite 1.0.0-v3.98 → 1.0.0

package/dist/cjs/Modal/Modal.d.ts

@@ -0,0 +1,62 @@
+import type { ReactNode, VFC } from "react";
+import type { XOR } from "../types";
+import { ModalFooter } from "./components/ModalFooter";
+import { ModalSection } from "./components/ModalSection";
+export declare type ModalSizeVariant = "medium" | "large";
+export declare type ModalLocale = {
+    dismissText?: string;
+    modalTitle?: string;
+};
+interface ModalControlledProps {
+    /** Define whether the modal is open or closed. */
+    open: boolean;
+    /** The element that should receive focus once the `Modal` is closed. */
+    autoFocusOnCloseElement?: HTMLElement | null;
+}
+interface ModalUncontrolledProps {
+    /** Button which should trigger the modal */
+    triggerButton: ReactNode;
+}
+export declare type ModalProps = XOR<ModalControlledProps, ModalUncontrolledProps> & {
+    /** Descriptive title for `Modal`. */
+    title?: ReactNode;
+    /** @ignore */
+    className?: string;
+    /** Define whether the content should take up the full width of the `Modal`. */
+    fullBleed?: boolean;
+    /** Define whether or not the modal should animate on show and hide. */
+    animate?: boolean;
+    /** Define the size of the `Modal`. */
+    size?: ModalSizeVariant;
+    /** Define whether or not the dismiss button should be hidden. */
+    hideCloseIcon?: boolean;
+    /** Define whether or not the modal should be vertically aligned. */
+    centerY?: boolean;
+    /**
+     * Function triggered when the modal is dismissed.
+     * This function is called when the user clicks the close button,
+     * clicks outside the modal or presses the escape key.
+     */
+    onDismiss?: () => void;
+    /** The locale for the `Modal`. */
+    locale?: ModalLocale;
+    /**
+     * The element that should receive focus once the `Modal` is opened.
+     * If unspecified, the first focusable element will be focused.
+     * If an element is passed, it will be focused.
+     * If 'skip' is passed, the close button will be focused if present, with a fallback on the dialog element itself.
+     */
+    autoFocusOnOpenElement?: HTMLElement | null | "skipContent";
+    children: ReactNode;
+};
+declare type ModalSubComponents = {
+    Footer: typeof ModalFooter;
+    Section: typeof ModalSection;
+};
+/**
+ * The `Modal` component is a dialog window that is used to display content on top of an application.
+ *
+ * See the [Modal documentation page](https://satellite.algolia.com/components/overlay/modal) for more information.
+ */
+export declare const Modal: VFC<ModalProps> & ModalSubComponents;
+export {};

package/dist/cjs/Modal/Modal.js

@@ -0,0 +1,139 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Modal = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var Dialog = _interopRequireWildcard(require("@radix-ui/react-dialog"));
+var _clsx = _interopRequireDefault(require("clsx"));
+var _react = require("react");
+var _Button = require("../Button");
+var _Card = require("../Card");
+var _Icons = require("../Icons");
+var _Satellite = require("../Satellite");
+var _satellitePrefixer = _interopRequireDefault(require("../styles/helpers/satellitePrefixer"));
+var _prefersReducedMotion = require("../utils/prefersReducedMotion");
+var _ModalFooter = require("./components/ModalFooter");
+var _ModalSection = require("./components/ModalSection");
+var _jsxRuntime = require("react/jsx-runtime");
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9, _templateObject10, _templateObject11, _templateObject12, _templateObject13, _templateObject14, _templateObject15;
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var DEFAULT_MODAL_LOCALE = {
+  dismissText: "Dismiss",
+  modalTitle: "Modal"
+};
+var SIZE_CLASSNAMES = {
+  medium: (0, _satellitePrefixer["default"])(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["modal-dialog-medium"]))),
+  large: (0, _satellitePrefixer["default"])(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["modal-dialog-large"])))
+};
+
+/**
+ * The `Modal` component is a dialog window that is used to display content on top of an application.
+ *
+ * See the [Modal documentation page](https://satellite.algolia.com/components/overlay/modal) for more information.
+ */
+var Modal = exports.Modal = function Modal(_ref) {
+  var title = _ref.title,
+    className = _ref.className,
+    children = _ref.children,
+    _ref$open = _ref.open,
+    open = _ref$open === void 0 ? false : _ref$open,
+    onDismiss = _ref.onDismiss,
+    _ref$fullBleed = _ref.fullBleed,
+    fullBleed = _ref$fullBleed === void 0 ? false : _ref$fullBleed,
+    _ref$animate = _ref.animate,
+    animate = _ref$animate === void 0 ? true : _ref$animate,
+    _ref$hideCloseIcon = _ref.hideCloseIcon,
+    hideCloseIcon = _ref$hideCloseIcon === void 0 ? false : _ref$hideCloseIcon,
+    _ref$size = _ref.size,
+    size = _ref$size === void 0 ? "medium" : _ref$size,
+    _ref$centerY = _ref.centerY,
+    centerY = _ref$centerY === void 0 ? false : _ref$centerY,
+    autoFocusOnOpenElement = _ref.autoFocusOnOpenElement,
+    autoFocusOnCloseElement = _ref.autoFocusOnCloseElement,
+    triggerButton = _ref.triggerButton,
+    propsLocale = _ref.locale;
+  var contextLocale = (0, _Satellite.useLocale)("modal");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_MODAL_LOCALE), contextLocale), propsLocale);
+  var createPortal = (0, _Satellite.useCreatePortal)();
+  var isControlled = triggerButton === undefined;
+  var closeButtonRef = (0, _react.useRef)(null);
+  var dialogContentRef = (0, _react.useRef)(null);
+  if (typeof document === "undefined") return /*#__PURE__*/(0, _jsxRuntime.jsx)(_react.Fragment, {});
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(Dialog.Root, {
+    open: isControlled ? open : undefined,
+    onOpenChange: function onOpenChange(open) {
+      if (!open) {
+        onDismiss === null || onDismiss === void 0 || onDismiss();
+      }
+    },
+    modal: true,
+    children: [!isControlled && /*#__PURE__*/(0, _jsxRuntime.jsx)(Dialog.Trigger, {
+      asChild: true,
+      children: triggerButton
+    }), createPortal( /*#__PURE__*/(0, _jsxRuntime.jsx)(Dialog.Overlay, {
+      className: (0, _clsx["default"])(animate && !_prefersReducedMotion.prefersReducedMotion && (0, _satellitePrefixer["default"])(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["modal-animated"]))), (0, _satellitePrefixer["default"])(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["modal-overlay bg-grey-900/30 z-modalOverlay inset-0 fixed w-full h-full flex items-start justify-center overflow-x-hidden overflow-y-auto px-4 py-10"])))),
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(Dialog.Content, {
+        ref: dialogContentRef,
+        className: (0, _clsx["default"])((0, _satellitePrefixer["default"])(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["modal-content"]))), SIZE_CLASSNAMES[size], centerY && (0, _satellitePrefixer["default"])(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["flex m-auto"])))),
+        onOpenAutoFocus: function onOpenAutoFocus(e) {
+          var _closeButtonRef$curre;
+          if (!autoFocusOnOpenElement) return;
+          var elementToFocus = autoFocusOnOpenElement === "skipContent" ? (_closeButtonRef$curre = closeButtonRef.current) !== null && _closeButtonRef$curre !== void 0 ? _closeButtonRef$curre : dialogContentRef.current : autoFocusOnOpenElement;
+          if (elementToFocus) {
+            e.preventDefault();
+            elementToFocus.focus();
+          }
+        },
+        onCloseAutoFocus: function onCloseAutoFocus(e) {
+          if (autoFocusOnCloseElement instanceof HTMLElement) {
+            e.preventDefault();
+            autoFocusOnCloseElement.focus();
+          }
+        },
+        "aria-label": !title ? locale.modalTitle : undefined,
+        "aria-describedby": undefined,
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+          className: (0, _satellitePrefixer["default"])(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["modal-container"]))),
+          children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_Card.Card, {
+            as: "div",
+            elevation: "500",
+            className: (0, _clsx["default"])((0, _satellitePrefixer["default"])(_templateObject8 || (_templateObject8 = (0, _taggedTemplateLiteral2["default"])(["relative"]))), className),
+            fullBleed: true,
+            children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("header", {
+              className: (0, _clsx["default"])((0, _satellitePrefixer["default"])(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2["default"])(["min-h-14 flex items-center justify-between space-x-2"]))), title ? (0, _satellitePrefixer["default"])(_templateObject10 || (_templateObject10 = (0, _taggedTemplateLiteral2["default"])(["border-b border-grey-100 pl-8 pr-16"]))) : (0, _satellitePrefixer["default"])(_templateObject11 || (_templateObject11 = (0, _taggedTemplateLiteral2["default"])(["justify-end px-8"]))), !title && hideCloseIcon && (0, _satellitePrefixer["default"])(_templateObject12 || (_templateObject12 = (0, _taggedTemplateLiteral2["default"])(["hidden"])))),
+              children: !!title && /*#__PURE__*/(0, _jsxRuntime.jsx)(Dialog.Title, {
+                className: (0, _satellitePrefixer["default"])(_templateObject13 || (_templateObject13 = (0, _taggedTemplateLiteral2["default"])(["flex-1 display-heading truncate"]))),
+                children: title
+              })
+            }), /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+              className: (0, _clsx["default"])(!fullBleed && (0, _satellitePrefixer["default"])(_templateObject14 || (_templateObject14 = (0, _taggedTemplateLiteral2["default"])(["p-10"])))),
+              children: children
+            }), !hideCloseIcon && /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+              className: (0, _satellitePrefixer["default"])(_templateObject15 || (_templateObject15 = (0, _taggedTemplateLiteral2["default"])(["-mr-2 absolute top-3 right-8"]))),
+              children: /*#__PURE__*/(0, _jsxRuntime.jsx)(Dialog.Close, {
+                ref: closeButtonRef,
+                asChild: true,
+                children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Button.IconButton, {
+                  icon: _Icons.XIcon,
+                  title: locale.dismissText,
+                  variant: "subtle",
+                  showTooltip: false
+                })
+              })
+            })]
+          })
+        })
+      })
+    }))]
+  });
+};
+Modal.Footer = _ModalFooter.ModalFooter;
+Modal.Section = _ModalSection.ModalSection;

package/dist/cjs/Modal/Modal.tailwind.d.ts

@@ -0,0 +1,5 @@
+export = modalPlugin;
+declare const modalPlugin: {
+    handler: import("tailwindcss/types/config").PluginCreator;
+    config?: Partial<import("tailwindcss/types/config").Config> | undefined;
+};

package/dist/cjs/Modal/Modal.tailwind.js

@@ -0,0 +1,81 @@
+"use strict";
+
+// @ts-check
+var plugin = require("tailwindcss/plugin");
+var modalPlugin = plugin(function (_ref) {
+  var addComponents = _ref.addComponents,
+    theme = _ref.theme;
+  var transitionEasing = "cubic-bezier(0.6, -0.28, 0.735, 0.045)";
+  var transitionDuration = "200ms";
+  addComponents({
+    ".modal-container": {
+      zIndex: theme("zIndex.modal")
+    },
+    ".modal-content": {
+      borderRadius: "8px",
+      width: "100%",
+      "&:focus": {
+        outline: "none"
+      }
+    },
+    // Sizes
+    ".modal-dialog-medium": {
+      maxWidth: "640px"
+    },
+    ".modal-dialog-large": {
+      maxWidth: "920px"
+    }
+  });
+
+  // Animation
+  addComponents({
+    /* eslint-disable @algolia/stl/prefer-stl-helper */
+    "@keyframes stl-modal-overlay-fade-in": {
+      from: {
+        opacity: "0"
+      },
+      to: {
+        opacity: "1"
+      }
+    },
+    "@keyframes stl-modal-overlay-fade-out": {
+      from: {
+        opacity: "1"
+      },
+      to: {
+        opacity: "0"
+      }
+    },
+    "@keyframes stl-modal-content-zoop-in": {
+      from: {
+        transform: "translate(0, 8px) scale(0.94)"
+      },
+      to: {
+        transform: "translate(0, 0) scale(1)"
+      }
+    },
+    "@keyframes stl-modal-content-zoop-out": {
+      from: {
+        transform: "translate(0, 0) scale(1)"
+      },
+      to: {
+        transform: "translate(0, 8px) scale(0.94)"
+      }
+    },
+    ".modal-animated.modal-overlay[data-state='open']": {
+      animation: "stl-modal-overlay-fade-in ".concat(transitionDuration, " ").concat(transitionEasing)
+    },
+    ".modal-animated.modal-overlay[data-state='closed']": {
+      animation: "stl-modal-overlay-fade-out ".concat(transitionDuration, " ").concat(transitionEasing)
+    },
+    ".modal-animated .modal-content[data-state='open']": {
+      animation: "stl-modal-content-zoop-in ".concat(transitionDuration, " ").concat(transitionEasing)
+    },
+    ".modal-animated .modal-content[data-state='closed']": {
+      animation: "stl-modal-content-zoop-out ".concat(transitionDuration, " ").concat(transitionEasing)
+    }
+    /* eslint-enable @algolia/stl/prefer-stl-helper */
+  });
+});
+
+module.exports = modalPlugin;

package/dist/cjs/Modal/components/ModalFooter.d.ts

@@ -0,0 +1,5 @@
+import type { HTMLAttributes, ReactNode, VFC } from "react";
+export declare type ModalFooterProps = HTMLAttributes<HTMLElement> & {
+    children: ReactNode;
+};
+export declare const ModalFooter: VFC<ModalFooterProps>;

package/dist/cjs/Modal/components/ModalFooter.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ModalFooter = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _clsx = _interopRequireDefault(require("clsx"));
+var _FlexGrid = require("../../FlexGrid");
+var _satellitePrefixer = _interopRequireDefault(require("../../styles/helpers/satellitePrefixer"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _templateObject;
+var _excluded = ["className", "children"];
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var ModalFooter = exports.ModalFooter = function ModalFooter(_ref) {
+  var className = _ref.className,
+    children = _ref.children,
+    props = (0, _objectWithoutProperties2["default"])(_ref, _excluded);
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)("div", _objectSpread(_objectSpread({}, props), {}, {
+    className: (0, _clsx["default"])((0, _satellitePrefixer["default"])(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["mt-8"]))), className),
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_FlexGrid.FlexGrid, {
+      spacing: "md",
+      alignment: "center",
+      children: children
+    })
+  }));
+};

package/dist/cjs/Modal/components/ModalSection.d.ts

@@ -0,0 +1,9 @@
+import type { ReactNode, VFC } from "react";
+export declare type ModalSectionProps = {
+    children: ReactNode;
+    /** @ignore */
+    className?: string;
+    /** Negates the modal default horizontal padding when true */
+    fullBleed?: boolean;
+};
+export declare const ModalSection: VFC<ModalSectionProps>;

package/dist/cjs/Modal/components/ModalSection.js

@@ -0,0 +1,22 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ModalSection = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _clsx = _interopRequireDefault(require("clsx"));
+var _satellitePrefixer = _interopRequireDefault(require("../../styles/helpers/satellitePrefixer"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _templateObject;
+var ModalSection = exports.ModalSection = function ModalSection(_ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    _ref$fullBleed = _ref.fullBleed,
+    fullBleed = _ref$fullBleed === void 0 ? false : _ref$fullBleed;
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)("section", {
+    className: (0, _clsx["default"])(fullBleed && (0, _satellitePrefixer["default"])(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["-mx-10"]))), className),
+    children: children
+  });
+};

package/dist/cjs/Modal/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Modal";
+export * from "./components/ModalFooter";
+export * from "./components/ModalSection";

package/dist/cjs/Modal/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _Modal = require("./Modal");
+Object.keys(_Modal).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Modal[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Modal[key];
+    }
+  });
+});
+var _ModalFooter = require("./components/ModalFooter");
+Object.keys(_ModalFooter).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ModalFooter[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ModalFooter[key];
+    }
+  });
+});
+var _ModalSection = require("./components/ModalSection");
+Object.keys(_ModalSection).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ModalSection[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ModalSection[key];
+    }
+  });
+});

package/dist/cjs/Pagination/CompactPagination/CompactPagination.d.ts

@@ -0,0 +1,36 @@
+import type { VFC } from "react";
+export declare type CompactPaginationLabel = "complete" | "compact" | "none";
+export declare type CompactPaginationLocale = {
+    goToFirstPage?: string;
+    goToLastPage?: string;
+    goToNextPage?: string;
+    goToPreviousPage?: string;
+    label?(page: number, nbPages?: number): string;
+};
+declare type BaseCompactPaginationProps = {
+    /** Currently selected page (1 based index) */
+    currentPage: number;
+    onChange: (page: number) => void;
+    showGoToFirstPage?: boolean;
+    label?: CompactPaginationLabel;
+    locale?: CompactPaginationLocale;
+};
+export declare type DeterminateCompactPaginationProps = BaseCompactPaginationProps & {
+    nbPages: number;
+    showGoToLastPage?: boolean;
+};
+export declare type IndeterminateCompactPaginationProps = BaseCompactPaginationProps & {
+    nextDisabled?: boolean;
+};
+export declare type CompactPaginationProps = DeterminateCompactPaginationProps | IndeterminateCompactPaginationProps;
+/** @ignore */
+export declare const isDeterminateCompactPaginationProps: (props: CompactPaginationProps) => props is DeterminateCompactPaginationProps;
+/** @ignore */
+export declare const isIndeterminateCompactPaginationProps: (props: CompactPaginationProps) => props is IndeterminateCompactPaginationProps;
+/**
+ * The `CompactPagination` component is used to help our users to move through an ordered collection of items represented by a page number and arrows.
+ *
+ * See the [Compact Pagination documentation page](https://satellite.algolia.com/components/navigation/compact-pagination) for more information.
+ */
+export declare const CompactPagination: VFC<CompactPaginationProps>;
+export {};

package/dist/cjs/Pagination/CompactPagination/CompactPagination.js

@@ -0,0 +1,87 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isIndeterminateCompactPaginationProps = exports.isDeterminateCompactPaginationProps = exports.CompactPagination = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _Button = require("../../Button");
+var _Icons = require("../../Icons");
+var _Satellite = require("../../Satellite");
+var _satellitePrefixer = _interopRequireDefault(require("../../styles/helpers/satellitePrefixer"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _templateObject, _templateObject2;
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var DEFAULT_COMPACT_PAGINATION_LOCALE = {
+  goToFirstPage: "Go to first page",
+  goToPreviousPage: "Go to previous page",
+  goToNextPage: "Go to next page",
+  goToLastPage: "Go to last page",
+  label: function label(page, nbPages) {
+    return typeof nbPages === "number" ? "Page ".concat(page, " of ").concat(nbPages) : "Page ".concat(page, " of many");
+  }
+};
+/** @ignore */
+var isDeterminateCompactPaginationProps = exports.isDeterminateCompactPaginationProps = function isDeterminateCompactPaginationProps(props) {
+  return "nbPages" in props;
+};
+
+/** @ignore */
+var isIndeterminateCompactPaginationProps = exports.isIndeterminateCompactPaginationProps = function isIndeterminateCompactPaginationProps(props) {
+  return !isDeterminateCompactPaginationProps(props);
+};
+
+/**
+ * The `CompactPagination` component is used to help our users to move through an ordered collection of items represented by a page number and arrows.
+ *
+ * See the [Compact Pagination documentation page](https://satellite.algolia.com/components/navigation/compact-pagination) for more information.
+ */
+var CompactPagination = exports.CompactPagination = function CompactPagination(props) {
+  var _props$label;
+  var contextLocale = (0, _Satellite.useLocale)("compactPagination");
+  var locale = _objectSpread(_objectSpread({}, DEFAULT_COMPACT_PAGINATION_LOCALE), {}, {
+    contextLocale: contextLocale
+  }, props.locale);
+  var labelType = (_props$label = props.label) !== null && _props$label !== void 0 ? _props$label : isDeterminateCompactPaginationProps(props) ? "complete" : "compact";
+  var label = labelType === "none" ? null : labelType === "compact" ? "".concat(props.currentPage) : isDeterminateCompactPaginationProps(props) ? locale.label(props.currentPage, props.nbPages) : locale.label(props.currentPage);
+  var isFirstPage = props.currentPage === 1;
+  var isLastPage = isDeterminateCompactPaginationProps(props) ? props.currentPage === props.nbPages : !!props.nextDisabled;
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", {
+    className: (0, _satellitePrefixer["default"])(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["flex items-center space-x-2"]))),
+    children: [props.showGoToFirstPage && /*#__PURE__*/(0, _jsxRuntime.jsx)(_Button.IconButton, {
+      icon: _Icons.ChevronsLeftIcon,
+      title: locale.goToFirstPage,
+      onClick: function onClick() {
+        return props.onChange(1);
+      },
+      disabled: isFirstPage
+    }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Button.IconButton, {
+      icon: _Icons.ArrowLeftIcon,
+      title: locale.goToPreviousPage,
+      onClick: function onClick() {
+        return props.onChange(props.currentPage - 1);
+      },
+      disabled: isFirstPage
+    }), !!label && /*#__PURE__*/(0, _jsxRuntime.jsx)("span", {
+      className: (0, _satellitePrefixer["default"])(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["inline-block text-center tabular-nums px-2"]))),
+      children: label
+    }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Button.IconButton, {
+      icon: _Icons.ArrowRightIcon,
+      title: locale.goToNextPage,
+      onClick: function onClick() {
+        return props.onChange(props.currentPage + 1);
+      },
+      disabled: isLastPage
+    }), isDeterminateCompactPaginationProps(props) && props.showGoToLastPage && /*#__PURE__*/(0, _jsxRuntime.jsx)(_Button.IconButton, {
+      icon: _Icons.ChevronsRightIcon,
+      title: locale.goToLastPage,
+      onClick: function onClick() {
+        return props.onChange(props.nbPages);
+      },
+      disabled: isLastPage
+    })]
+  });
+};

package/dist/cjs/Pagination/CompactPagination/index.d.ts

@@ -0,0 +1 @@
+export * from "./CompactPagination";

package/dist/cjs/Pagination/CompactPagination/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _CompactPagination = require("./CompactPagination");
+Object.keys(_CompactPagination).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _CompactPagination[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _CompactPagination[key];
+    }
+  });
+});

package/dist/cjs/Pagination/DotPagination/DotPagination.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+import type { NumberUnion } from "utils/NumberUnion";
+export declare type DotPaginationLocale = {
+    goToPageText?(page: number): string;
+};
+export declare type DotPaginationProps<T extends number> = {
+    /** Currently selected page (1 based index) */
+    currentPage: NumberUnion<T>;
+    onChange: (page: NumberUnion<T>) => void;
+    nbPages: T;
+    size?: "small" | "medium";
+    locale?: DotPaginationLocale;
+};
+/**
+ * The `DotPagination` component is used to help our users to move through an ordered collection of items represented by dots.
+ *
+ * See the [Dot Pagination documentation page](https://satellite.algolia.com/components/navigation/dot-pagination) for more information.
+ */
+export declare const DotPagination: <T extends number>({ currentPage, onChange, nbPages, size, locale: propsLocale, }: DotPaginationProps<T>) => JSX.Element;

package/dist/cjs/Pagination/DotPagination/DotPagination.js

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DotPagination = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _Satellite = require("../../Satellite");
+var _satellitePrefixer = _interopRequireDefault(require("../../styles/helpers/satellitePrefixer"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _templateObject, _templateObject2;
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var DEFAULT_DOT_PAGINATION_LOCALE = {
+  goToPageText: function goToPageText(pageIdx) {
+    return "Go to page ".concat(pageIdx);
+  }
+};
+/**
+ * The `DotPagination` component is used to help our users to move through an ordered collection of items represented by dots.
+ *
+ * See the [Dot Pagination documentation page](https://satellite.algolia.com/components/navigation/dot-pagination) for more information.
+ */
+var DotPagination = exports.DotPagination = function DotPagination(_ref) {
+  var currentPage = _ref.currentPage,
+    onChange = _ref.onChange,
+    nbPages = _ref.nbPages,
+    _ref$size = _ref.size,
+    size = _ref$size === void 0 ? "medium" : _ref$size,
+    propsLocale = _ref.locale;
+  var contextLocale = (0, _Satellite.useLocale)("dotPagination");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_DOT_PAGINATION_LOCALE), contextLocale), propsLocale);
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)("ul", {
+    className: (0, _satellitePrefixer["default"])(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["flex"]))),
+    children: new Array(nbPages).fill(undefined).map(function (_, idx) {
+      var pageIdx = idx + 1;
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)("li", {
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)("button", {
+          "aria-label": locale.goToPageText(pageIdx),
+          className: (0, _satellitePrefixer["default"])(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n              rounded-full mx-1 border\n              ", "\n              ", "\n            "])), currentPage === pageIdx ? "bg-accent-600 border-transparent" : "bg-grey-200 border-grey-500", size === "medium" ? "h-3 w-3" : "h-2 w-2"),
+          onClick: function onClick() {
+            return onChange(pageIdx);
+          }
+        })
+      }, idx);
+    })
+  });
+};

package/dist/cjs/Pagination/DotPagination/index.d.ts

@@ -0,0 +1 @@
+export * from "./DotPagination";

package/dist/cjs/Pagination/DotPagination/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _DotPagination = require("./DotPagination");
+Object.keys(_DotPagination).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _DotPagination[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _DotPagination[key];
+    }
+  });
+});