@algolia/satellite 1.0.0-v3.99 → 1.1.0

package/dist/esm/Toast/Toast.tailwind.d.ts

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

package/dist/esm/Toast/Toast.tailwind.js

@@ -0,0 +1,33 @@
+import _plugin from "tailwindcss/plugin";
+// @ts-check
+var plugin = _plugin;
+var toastPlugin = plugin(function (_ref) {
+  var addComponents = _ref.addComponents;
+  var TRANSITION_TIMEOUT = 500;
+  addComponents({
+    ".toast": {
+      width: "320px"
+    }
+  });
+  addComponents({
+    ".toasts_item-enter": {
+      opacity: "0.01",
+      transform: "translate(0, 80px)"
+    },
+    ".toasts_item-enter-active": {
+      opacity: "1",
+      transform: "translate(0, 0)",
+      transition: "all ".concat(TRANSITION_TIMEOUT, "ms ease-in")
+    },
+    ".toasts_item-exit": {
+      opacity: "1",
+      transform: "translate(0, 0)"
+    },
+    ".toasts_item-exit-active": {
+      opacity: "0.01",
+      transform: "translate(0, 80px)",
+      transition: "all ".concat(TRANSITION_TIMEOUT, "ms ease-in")
+    }
+  });
+});
+export default toastPlugin;

package/dist/esm/Toast/Toasts.d.ts

@@ -0,0 +1,20 @@
+import type { VFC } from "react";
+import type { Notification } from "./types";
+export declare type ToastsLocale = {
+    hotkeyLabel?: string;
+};
+export interface ToastsProps {
+    /**
+     * Define the array of notifications.
+     * @example [{ id: "test", title: "Test", content: "Example" }]
+     */
+    notifications: Notification[];
+    /** Define the `Toasts` locale. */
+    locale?: ToastsLocale;
+}
+/**
+ * Toasts are brief notifications that providing timely feedback to users before vanishing after a short duration.
+ *
+ * See the [Toast documentation page](https://satellite.algolia.com/components/feedback/toast) for more information.
+ */
+export declare const Toasts: VFC<ToastsProps>;

package/dist/esm/Toast/Toasts.js

@@ -0,0 +1,92 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+var _excluded = ["content", "id", "autoDismissAfter"];
+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) { _defineProperty(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; }
+import * as ToastPrimitive from "@radix-ui/react-toast";
+import { CSSTransition, TransitionGroup } from "react-transition-group";
+import { useCreatePortal, useLocale } from "../Satellite";
+import stl from "../styles/helpers/satellitePrefixer";
+import { prefersReducedMotion } from "../utils/prefersReducedMotion";
+import { Toast } from "./Toast";
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+var DEFAULT_TOASTS_LOCALE = {
+  hotkeyLabel: "Notifications"
+};
+var TRANSITION_TIMEOUT = 500;
+
+/**
+ * Toasts are brief notifications that providing timely feedback to users before vanishing after a short duration.
+ *
+ * See the [Toast documentation page](https://satellite.algolia.com/components/feedback/toast) for more information.
+ */
+export var Toasts = function Toasts(_ref) {
+  var _ref$notifications = _ref.notifications,
+    notifications = _ref$notifications === void 0 ? [] : _ref$notifications,
+    propsLocale = _ref.locale;
+  var contextLocale = useLocale("toasts");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_TOASTS_LOCALE), contextLocale), propsLocale);
+  var createPortal = useCreatePortal();
+  if (process.env.NODE_ENV !== "production") {
+    if (notifications.length > 3) {
+      console.warn("Toasts: You should not display more than 3 toasts simultaneously.");
+    }
+    if (notifications.find(function (n) {
+      return n.autoDismissAfter && n.autoDismissAfter < 2000;
+    })) {
+      console.warn("Toasts: You should not set `autoDismissAfter` to less than 2000 ms, even for brief messages.");
+    }
+  }
+  return createPortal( /*#__PURE__*/_jsxs(ToastPrimitive.Provider, {
+    children: [/*#__PURE__*/_jsx(TransitionGroup, {
+      component: null,
+      children: notifications.map(function (_ref2) {
+        var content = _ref2.content,
+          id = _ref2.id,
+          autoDismissAfter = _ref2.autoDismissAfter,
+          rest = _objectWithoutProperties(_ref2, _excluded);
+        return /*#__PURE__*/_jsx(CSSTransition, {
+          classNames: !prefersReducedMotion ? {
+            enter: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["toasts_item-enter"]))),
+            enterActive: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["toasts_item-enter-active"]))),
+            exit: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["toasts_item-exit"]))),
+            exitActive: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["toasts_item-exit-active"])))
+          } : {},
+          timeout: !prefersReducedMotion ? TRANSITION_TIMEOUT : 0,
+          appear: true,
+          children: /*#__PURE__*/_jsx(ToastPrimitive.Root, {
+            open: true,
+            onOpenChange: function onOpenChange(open) {
+              var _rest$onDismiss;
+              if (!open) (_rest$onDismiss = rest.onDismiss) === null || _rest$onDismiss === void 0 || _rest$onDismiss.call(rest);
+            },
+            onSwipeEnd: function onSwipeEnd(e) {
+              return e.preventDefault();
+            } // Prevent swipe gesture
+            ,
+            duration: autoDismissAfter || Infinity,
+            // Accessibility issue from Radix: `role="status"` is not allowed on a `li` element, as a workaround,
+            // we use it on the child.
+            // See https://github.com/radix-ui/primitives/issues/1750
+            role: "listitem",
+            "aria-live": undefined,
+            "aria-atomic": undefined,
+            children: /*#__PURE__*/_jsx(Toast, _objectSpread(_objectSpread({}, rest), {}, {
+              role: "status",
+              "aria-live": "polite",
+              "aria-atomic": "true",
+              children: content
+            }))
+          })
+        }, id);
+      })
+    }), /*#__PURE__*/_jsx(ToastPrimitive.Viewport, {
+      hotkey: ["metaKey", "F8"],
+      label: "".concat(locale.hotkeyLabel, " (CmdKey+F8/WinKey+F8)}"),
+      className: stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["z-notification bottom-0 right-0 fixed flex flex-col items-end p-4 gap-4"])))
+    })]
+  }));
+};

package/dist/esm/Toast/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Toast";
+export * from "./Toasts";
+export * from "./types";

package/dist/esm/Toast/index.js

@@ -0,0 +1,3 @@
+export * from "./Toast";
+export * from "./Toasts";
+export * from "./types";

package/dist/esm/Toast/types.d.ts

@@ -0,0 +1,34 @@
+import type { ReactNode, ReactPortal } from "react";
+import type { IconComponentType } from "../Icons";
+import type { ColorVariant } from "../types";
+export declare type Notification = {
+    /** Defines an unique ID for the `Toast`. */
+    id: string;
+    /** Defines the title for the `Toast`. Will be rendered in a heading element. */
+    title: Exclude<ReactNode, ReactPortal>;
+    /** Defines the content for the `Toast`. */
+    content?: Exclude<ReactNode, ReactPortal>;
+    /** Defines the icon for the `Toast`. */
+    icon?: IconComponentType;
+    /**
+     * Defines the color variant of the `Toast`.
+     * @default false
+     */
+    loading?: boolean;
+    /**
+     * Defines the color variant of the `Toast`.
+     * @default "blue"
+     */
+    variant?: ColorVariant;
+    /** Defines if and how long before the `Toast` should be dismissed (in ms). */
+    autoDismissAfter?: number;
+    /**
+     * Defines a function called when the `Toast` dismiss button is clicked or the `autoDismissAfter` time has elapsed.
+     * Dismiss button won't be rendered if absent.
+     */
+    onDismiss?: () => void;
+    /** Define locale for the `Toast`. */
+    locale?: {
+        dismissText?: string;
+    };
+};

package/dist/esm/Toast/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/Toggle/Toggle.d.ts

@@ -0,0 +1,12 @@
+import type { HTMLAttributes, InputHTMLAttributes } from "react";
+export declare type ToggleProps = Omit<HTMLAttributes<HTMLInputElement>, "children" | "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "onChange" | "required" | "autoFocus" | "disabled" | "checked" | "defaultChecked"> & {
+    decorative?: boolean;
+};
+/**
+ * The `Toggle` component is used to view or switch between enabled or disabled states.
+ *
+ * See the [Toggle documentation page](https://satellite.algolia.com/components/controls/toggle) for more information.
+ */
+export declare const Toggle: import("react").ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLInputElement>, "children" | "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "defaultChecked" | "onChange" | "required" | "autoFocus" | "disabled" | "checked"> & {
+    decorative?: boolean | undefined;
+} & import("react").RefAttributes<HTMLInputElement>>;

package/dist/esm/Toggle/Toggle.js

@@ -0,0 +1,84 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
+var _excluded = ["className", "checked", "decorative", "defaultChecked", "required"];
+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) { _defineProperty(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; }
+import cx from "clsx";
+import { forwardRef, useState } from "react";
+import { useField } from "../Field";
+import stl from "../styles/helpers/satellitePrefixer";
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * The `Toggle` component is used to view or switch between enabled or disabled states.
+ *
+ * See the [Toggle documentation page](https://satellite.algolia.com/components/controls/toggle) for more information.
+ */
+export var Toggle = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var _inputProps$id;
+  var className = _ref.className,
+    checked = _ref.checked,
+    decorative = _ref.decorative,
+    defaultChecked = _ref.defaultChecked,
+    required = _ref.required,
+    inputProps = _objectWithoutProperties(_ref, _excluded);
+  var isControlled = typeof checked === "boolean";
+  var _useState = useState(Boolean(isControlled ? checked : defaultChecked)),
+    _useState2 = _slicedToArray(_useState, 2),
+    internalChecked = _useState2[0],
+    setInternalChecked = _useState2[1];
+  var isChecked = Boolean(isControlled ? checked : internalChecked);
+  var isDisabled = inputProps.disabled,
+    onChange = inputProps.onChange;
+  var _useField = useField({
+      required: required
+    }),
+    state = _useField.state,
+    labelId = _useField.labelId,
+    descriptionId = _useField.descriptionId,
+    inputId = _useField.inputId;
+  var isInvalid = state.status === "invalid";
+  var handleChange = function handleChange(evt) {
+    onChange === null || onChange === void 0 || onChange(evt);
+    if (!isControlled && !evt.isDefaultPrevented()) {
+      setInternalChecked(evt.currentTarget.checked);
+    }
+  };
+  var handleClassName = cx(stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["toggle-handle"]))), isChecked && stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["toggle-checked"]))), isDisabled && stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["toggle-disabled"]))), isInvalid && stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["toggle-invalid"]))));
+  var onClick = function onClick(event) {
+    if (isDisabled) {
+      return;
+    }
+    onChange === null || onChange === void 0 || onChange(event);
+    !isControlled && setInternalChecked(!isChecked);
+  };
+  return /*#__PURE__*/_jsxs("div", {
+    translate: "yes",
+    className: cx(stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["toggle-container"]))), className),
+    children: [decorative ? /*#__PURE__*/_jsx("span", {
+      className: handleClassName,
+      onClick: onClick
+    }) : /*#__PURE__*/_jsx("input", _objectSpread(_objectSpread({
+      "aria-labelledby": labelId,
+      "aria-describedby": descriptionId
+    }, inputProps), {}, {
+      id: (_inputProps$id = inputProps.id) !== null && _inputProps$id !== void 0 ? _inputProps$id : inputId,
+      required: required,
+      "aria-invalid": isInvalid,
+      className: handleClassName,
+      disabled: isDisabled,
+      onChange: handleChange,
+      checked: isChecked,
+      "aria-checked": isChecked,
+      type: "checkbox",
+      role: "switch",
+      ref: ref
+    })), /*#__PURE__*/_jsx("div", {
+      className: stl(_templateObject6 || (_templateObject6 = _taggedTemplateLiteral(["toggle"])))
+    })]
+  });
+});
+Toggle.displayName = "Toggle";

package/dist/esm/Toggle/Toggle.tailwind.d.ts

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

package/dist/esm/Toggle/Toggle.tailwind.js

@@ -0,0 +1,93 @@
+import _rgba from "../styles/rgba";
+import _plugin from "tailwindcss/plugin";
+// @ts-check
+var plugin = _plugin;
+var rgba = _rgba;
+var togglePlugin = plugin(function (_ref) {
+  var addComponents = _ref.addComponents,
+    theme = _ref.theme;
+  var transition = "all 72ms ease-in-out";
+  addComponents({
+    ".toggle-container": {
+      position: "relative",
+      display: "block",
+      height: "18px",
+      width: "32px",
+      ".toggle-handle": {
+        position: "absolute",
+        top: "0px",
+        left: "0px",
+        width: "100%",
+        height: "100%",
+        opacity: "0",
+        cursor: "pointer",
+        "&.toggle-disabled": {
+          cursor: "not-allowed"
+        }
+      },
+      "&:hover .toggle:after": {
+        transform: "translateX(2px)"
+      },
+      "&:hover .toggle-handle.toggle-checked ~ .toggle:after": {
+        transform: "translateX(12px)"
+      },
+      "&:hover .toggle-handle.toggle-disabled ~ .toggle:after": {
+        transform: "translateX(0px)"
+      },
+      "&:hover .toggle-handle.toggle-checked.toggle-disabled ~ .toggle:after": {
+        transform: "translateX(14px)"
+      }
+    },
+    ".toggle": {
+      position: "absolute",
+      top: "0px",
+      left: "0px",
+      width: "100%",
+      height: "100%",
+      pointerEvents: "none",
+      borderRadius: "9999px",
+      background: theme("colors.grey.500"),
+      boxShadow: "inset 0px 1px 4px 0px ".concat(rgba(theme("colors.grey.500"), 0.2)),
+      transition: transition,
+      "&::after": {
+        position: "absolute",
+        top: "1px",
+        left: "1px",
+        width: "16px",
+        height: "16px",
+        content: '" "',
+        borderRadius: "9999px",
+        background: "linear-gradient(-180deg, ".concat(theme("colors.white"), " 0%, ").concat(theme("colors.grey.50"), " 100%)"),
+        boxShadow: "0px 1px 1px 0px ".concat(theme("colors.shadow.10")),
+        transition: transition
+      },
+      ".toggle-handle.toggle-checked ~ &": {
+        background: theme("colors.accent.600"),
+        boxShadow: "inset 0px 1px 4px 0px ".concat(rgba(theme("colors.grey.900"), 0.1)),
+        "&:after": {
+          transform: "translateX(14px)"
+        }
+      },
+      ".toggle-handle.toggle-disabled ~ &": {
+        background: theme("colors.grey.200")
+      },
+      ".toggle-checked.toggle-handle.toggle-disabled ~ &": {
+        background: theme("colors.xenon.200")
+      },
+      ".toggle-handle.toggle-invalid ~ &": {
+        background: theme("colors.red.700"),
+        "&:after": {
+          background: theme("colors.red.100")
+        }
+      }
+    },
+    "input:focus ~ .toggle": {
+      outline: "2px solid ".concat(theme("colors.accent.600")),
+      outlineOffset: "1px"
+    },
+    "input:focus.toggle-invalid ~ .toggle": {
+      outlineColor: theme("colors.red.700")
+    }
+  });
+});
+export default togglePlugin;

package/dist/esm/Toggle/index.d.ts

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

package/dist/esm/Toggle/index.js

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

package/dist/esm/Tooltip/OverflowTooltipWrapper.d.ts

@@ -0,0 +1,10 @@
+import type { VFC } from "react";
+import type { TooltipWrapperBaseProps } from "./types";
+export interface OverflowTooltipWrapperProps extends TooltipWrapperBaseProps {
+}
+/**
+ * The `OverflowTooltipWrapper` component is used to wrap text that may overflow its container and display a tooltip with the full text on hover.
+ *
+ * See the [Tooltip documentation page](https://satellite.algolia.com/components/overlay/tooltip) for more information.
+ */
+export declare const OverflowTooltipWrapper: VFC<OverflowTooltipWrapperProps>;

package/dist/esm/Tooltip/OverflowTooltipWrapper.js

@@ -0,0 +1,44 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _templateObject;
+var _excluded = ["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) { _defineProperty(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; }
+import { Slot } from "@radix-ui/react-slot";
+import { useState } from "react";
+import stl from "../styles/helpers/satellitePrefixer";
+import { TextWrap } from "../TextWrap";
+import { isReactText } from "../utils/isReactText";
+import { TooltipWrapper } from "./TooltipWrapper";
+import { isOverflowing } from "./utils";
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * The `OverflowTooltipWrapper` component is used to wrap text that may overflow its container and display a tooltip with the full text on hover.
+ *
+ * See the [Tooltip documentation page](https://satellite.algolia.com/components/overlay/tooltip) for more information.
+ */
+export var OverflowTooltipWrapper = function OverflowTooltipWrapper(_ref) {
+  var children = _ref.children,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var _useState = useState(null),
+    _useState2 = _slicedToArray(_useState, 2),
+    content = _useState2[0],
+    setContent = _useState2[1];
+  var onMouseEnter = function onMouseEnter(evt) {
+    setContent(isOverflowing(evt.currentTarget) ? evt.currentTarget.textContent : null);
+  };
+  var Wrapper = isReactText(children) ? "div" : Slot;
+  return /*#__PURE__*/_jsx(TooltipWrapper, _objectSpread(_objectSpread({
+    content: content && /*#__PURE__*/_jsx(TextWrap, {
+      children: content
+    })
+  }, props), {}, {
+    children: /*#__PURE__*/_jsx(Wrapper, {
+      className: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["truncate"]))),
+      onMouseEnter: onMouseEnter,
+      children: children
+    })
+  }));
+};

package/dist/esm/Tooltip/Tooltip.d.ts

@@ -0,0 +1,11 @@
+import type { DetailedHTMLProps, HTMLAttributes } from "react";
+export declare type TooltipVariant = "dark" | "light";
+export interface TooltipProps extends DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement> {
+    variant?: TooltipVariant;
+}
+/**
+ * The `Tooltip` component displays additional information when hovering/focusing on an element. It is used to provide clarification or identify the purpose of UI elements.
+ *
+ * See the [Tooltip documentation page](https://satellite.algolia.com/components/overlay/tooltip) for more information.
+ */
+export declare const Tooltip: import("react").ForwardRefExoticComponent<Pick<TooltipProps, "slot" | "style" | "title" | "children" | "id" | "variant" | "className" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "key"> & import("react").RefAttributes<HTMLDivElement>>;

package/dist/esm/Tooltip/Tooltip.js

@@ -0,0 +1,32 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _excluded = ["className", "variant"];
+var _templateObject, _templateObject2, _templateObject3;
+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) { _defineProperty(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; }
+import cx from "clsx";
+import { forwardRef } from "react";
+import stl from "../styles/helpers/satellitePrefixer";
+import { jsx as _jsx } from "react/jsx-runtime";
+var VARIANT_CLASSNAMES = {
+  dark: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["tooltip-dark"]))),
+  light: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["tooltip-light"])))
+};
+
+/**
+ * The `Tooltip` component displays additional information when hovering/focusing on an element. It is used to provide clarification or identify the purpose of UI elements.
+ *
+ * See the [Tooltip documentation page](https://satellite.algolia.com/components/overlay/tooltip) for more information.
+ */
+export var Tooltip = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    _ref$variant = _ref.variant,
+    variant = _ref$variant === void 0 ? "dark" : _ref$variant,
+    divProps = _objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/_jsx("div", _objectSpread(_objectSpread({}, divProps), {}, {
+    className: cx(stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["tooltip typo-display-body"]))), VARIANT_CLASSNAMES[variant], className),
+    ref: ref
+  }));
+});
+Tooltip.displayName = "Tooltip";

package/dist/esm/Tooltip/Tooltip.tailwind.d.ts

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

package/dist/esm/Tooltip/Tooltip.tailwind.js

@@ -0,0 +1,46 @@
+import _plugin from "tailwindcss/plugin";
+// @ts-check
+var plugin = _plugin;
+var tooltipPlugin = plugin(function (_ref) {
+  var addComponents = _ref.addComponents,
+    theme = _ref.theme;
+  /** @type {string} */
+  var tooltipDarkBackground = theme("colors.grey.900");
+  /** @type {string} */
+  var tooltipLightBackground = theme("colors.white");
+  addComponents({
+    ".tooltip": {
+      padding: "".concat(theme("spacing.1"), " ").concat(theme("spacing.2")),
+      backgroundColor: tooltipDarkBackground,
+      color: theme("colors.white"),
+      boxShadow: theme("boxShadow.z200"),
+      borderRadius: theme("borderRadius.DEFAULT"),
+      // Used on the dashboard, should probably move over there
+      code: {
+        color: "currentColor",
+        border: "1px solid currentColor",
+        background: "initial",
+        whiteSpace: "nowrap",
+        lineHeight: "2"
+      }
+    },
+    ".tooltip-dark": {
+      ".typo-link": {
+        color: theme("colors.accent.300"),
+        textDecoration: "underline"
+      }
+    },
+    ".tooltip-light": {
+      color: theme("colors.grey.900"),
+      backgroundColor: tooltipLightBackground
+    }
+  });
+  addComponents({
+    ".tooltip-content": {
+      zIndex: theme("zIndex.tooltip"),
+      userSelect: "none",
+      maxWidth: theme("spacing.64")
+    }
+  });
+});
+export default tooltipPlugin;

package/dist/esm/Tooltip/TooltipWrapper.d.ts

@@ -0,0 +1,19 @@
+import type { ReactNode, VFC } from "react";
+import type { TooltipWrapperBaseProps } from "./types";
+export interface TooltipWrapperProps extends TooltipWrapperBaseProps {
+    /**
+     * Defines whether the `Tooltip` should be displayed or not.
+     * @default undefined
+     */
+    show?: boolean;
+    /**
+     * Defines the content of the `Tooltip`.
+     */
+    content: ReactNode;
+}
+/**
+ * The `TooltipWrapper` component is used to wrap content and display a tooltip on hover.
+ *
+ * See the [Tooltip documentation page](https://satellite.algolia.com/components/overlay/tooltip) for more information.
+ */
+export declare const TooltipWrapper: VFC<TooltipWrapperProps>;