@algolia/satellite 1.0.0-beta.17 → 1.0.0-beta.170

package/esm/ScrollIndicator/ScrollIndicator.js

@@ -0,0 +1,79 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+import cx from "clsx";
+import { createElement, useCallback, useMemo, useState } from "react";
+import useMeasure from "react-use/lib/useMeasure";
+import useScroll from "react-use/lib/useScroll";
+import stl from "../styles/helpers/satellitePrefixer";
+import { jsx as _jsx } from "react/jsx-runtime";
+var useScrollIndicators = function useScrollIndicators() {
+  /**
+   * We don't use the actual measurements from the hook because they're not as precise
+   * (see limitations https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
+   *
+   * This is mostly used as a side-effect to force the component to rerender when its size changes
+   */
+  var _useMeasure = useMeasure(),
+    _useMeasure2 = _slicedToArray(_useMeasure, 1),
+    setMeasureRef = _useMeasure2[0];
+  var _useState = useState(null),
+    _useState2 = _slicedToArray(_useState, 2),
+    element = _useState2[0],
+    setElement = _useState2[1];
+  var setScrollIndicatorsRef = useCallback(function (element) {
+    setElement(element);
+    // Types are wrong, a ref callback must be able to accept null
+    // @ts-ignore
+    setMeasureRef(element);
+  }, [setMeasureRef]);
+  var fakeScrollRef = useMemo(function () {
+    return {
+      current: element
+    };
+  }, [element]);
+  var _useScroll = useScroll(fakeScrollRef),
+    scrollTop = _useScroll.y;
+  var result = {
+    showTopIndicator: false,
+    showBottomIndicator: false,
+    setScrollIndicatorsRef: setScrollIndicatorsRef
+  };
+  if (element) {
+    var scrollHeight = element.scrollHeight - element.clientHeight;
+    if (scrollHeight > 0) {
+      var percent = Math.floor(scrollTop / scrollHeight * 100);
+      result.showTopIndicator = percent > 0;
+      result.showBottomIndicator = percent < 100;
+    }
+  }
+  return result;
+};
+var VARIANT_CLASSNAMES = {
+  light: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["scroll-indicator"]))),
+  dark: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["scroll-indicator scroll-indicator-dark"])))
+};
+export var ScrollIndicator = function ScrollIndicator(_ref) {
+  var _ref$tagName = _ref.tagName,
+    tagName = _ref$tagName === void 0 ? "div" : _ref$tagName,
+    _ref$variant = _ref.variant,
+    variant = _ref$variant === void 0 ? "light" : _ref$variant,
+    className = _ref.className,
+    wrapperClassName = _ref.wrapperClassName,
+    style = _ref.style,
+    children = _ref.children;
+  var _useScrollIndicators = useScrollIndicators(),
+    showTopIndicator = _useScrollIndicators.showTopIndicator,
+    showBottomIndicator = _useScrollIndicators.showBottomIndicator,
+    setScrollIndicatorsRef = _useScrollIndicators.setScrollIndicatorsRef;
+  return /*#__PURE__*/_jsx("div", {
+    className: cx(VARIANT_CLASSNAMES[variant], stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n          ", "\n          ", "\n        "])), showTopIndicator && "scroll-indicator-top", showBottomIndicator && "scroll-indicator-bottom"), wrapperClassName),
+    children: /*#__PURE__*/createElement(tagName, {
+      style: style,
+      className: cx(stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["scroll-indicator-content"]))), className),
+      ref: setScrollIndicatorsRef,
+      tabIndex: 0
+    }, children)
+  });
+};
+export default ScrollIndicator;

package/esm/ScrollIndicator/ScrollIndicator.tailwind.d.ts

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

package/esm/ScrollIndicator/ScrollIndicator.tailwind.js

@@ -0,0 +1,50 @@
+import _rgba from "../styles/rgba";
+import _plugin from "tailwindcss/plugin";
+// @ts-check
+var plugin = _plugin;
+var rgba = _rgba;
+var scrollIndicatorPlugin = plugin(function (_ref) {
+  var addComponents = _ref.addComponents,
+    theme = _ref.theme;
+  addComponents({
+    ".scroll-indicator": {
+      position: "relative",
+      overflow: "hidden",
+      "&::before, &::after": {
+        position: "absolute",
+        width: "100%",
+        height: "48px",
+        left: "0px",
+        pointerEvents: "none"
+      },
+      "&::before": {
+        top: "0px",
+        backgroundImage: "linear-gradient(0, ".concat(rgba(theme("colors.white"), 0), " 0%, ").concat(theme("colors.white"), " 100%)")
+      },
+      "&::after": {
+        bottom: "0px",
+        backgroundImage: "linear-gradient(180deg, ".concat(rgba(theme("colors.white"), 0), " 0%, ").concat(theme("colors.white"), " 100%)")
+      }
+    },
+    ".scroll-indicator-dark": {
+      "&::before": {
+        backgroundImage: "linear-gradient(0, ".concat(rgba(theme("colors.grey.900"), 0), " 0%, ").concat(theme("colors.grey.900"), " 100%)")
+      },
+      "&::after": {
+        backgroundImage: "linear-gradient(180deg, ".concat(rgba(theme("colors.grey.900"), 0), " 0%, ").concat(theme("colors.grey.900"), " 100%)")
+      }
+    },
+    ".scroll-indicator-top::before": {
+      content: '" "'
+    },
+    ".scroll-indicator-bottom::after": {
+      content: '" "'
+    },
+    ".scroll-indicator-content": {
+      display: "block",
+      height: "100%",
+      overflowY: "auto"
+    }
+  });
+});
+export default scrollIndicatorPlugin;

package/esm/ScrollIndicator/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ScrollIndicator";
+export { default } from "./ScrollIndicator";

package/esm/ScrollIndicator/index.js

@@ -0,0 +1,2 @@
+export * from "./ScrollIndicator";
+export { default } from "./ScrollIndicator";

package/esm/Select/Select.d.ts

@@ -0,0 +1,15 @@
+import type { SelectHTMLAttributes } from "react";
+export declare type SelectVariants = "small" | "medium" | "large";
+export interface SelectProps extends SelectHTMLAttributes<HTMLSelectElement> {
+    variant?: SelectVariants;
+}
+/**
+ * Select lets users choose one option from an options menu. Consider select when you have 3 or more options, to avoid cluttering the interface.
+ *
+ * ## Usability best practices
+ * - Use for selecting between 3 or more predefined options (consider radio buttons for less than 3 options)
+ * - Have a default option selected whenever possible
+ * - Use `Select` as a placeholder option only if there's no logical default option
+ */
+export declare const Select: import("react").ForwardRefExoticComponent<SelectProps & import("react").RefAttributes<HTMLSelectElement>>;
+export default Select;

package/esm/Select/Select.js

@@ -0,0 +1,37 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _excluded = ["variant", "className"];
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+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 = {
+  small: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["select-input-small"]))),
+  medium: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["select-input-medium"]))),
+  large: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["select-input-large"])))
+};
+
+/**
+ * Select lets users choose one option from an options menu. Consider select when you have 3 or more options, to avoid cluttering the interface.
+ *
+ * ## Usability best practices
+ * - Use for selecting between 3 or more predefined options (consider radio buttons for less than 3 options)
+ * - Have a default option selected whenever possible
+ * - Use `Select` as a placeholder option only if there's no logical default option
+ */
+export var Select = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var _ref$variant = _ref.variant,
+    variant = _ref$variant === void 0 ? "medium" : _ref$variant,
+    className = _ref.className,
+    props = _objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/_jsx("select", _objectSpread(_objectSpread({}, props), {}, {
+    className: cx(stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["select-input display-body"]))), VARIANT_CLASSNAMES[variant], className),
+    ref: ref
+  }));
+});
+Select.displayName = "Select";
+export default Select;

package/esm/Select/Select.tailwind.d.ts

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

package/esm/Select/Select.tailwind.js

@@ -0,0 +1,77 @@
+import _require2 from "../styles/helpers/icons";
+import _disabledColor from "../styles/disabledColor";
+import _plugin from "tailwindcss/plugin";
+// @ts-check
+var plugin = _plugin;
+var disabledColor = _disabledColor;
+var _require = _require2,
+  selectIconBG = _require.selectIconBG;
+var selectPlugin = plugin(function (_ref) {
+  var addComponents = _ref.addComponents,
+    theme = _ref.theme;
+  addComponents({
+    // I chose .select-input to avoid name collision with tailwindcss.com/docs/user-select/
+    ".select-input": {
+      appearance: "none",
+      outline: "none",
+      cursor: "pointer",
+      position: "relative",
+      padding: "0 ".concat(theme("spacing.10"), " 0 ").concat(theme("spacing.4")),
+      width: "100%",
+      color: theme("colors.grey.900"),
+      backgroundColor: theme("colors.white"),
+      backgroundImage: "\n        ".concat(selectIconBG(theme("colors.grey.500")), ",\n        linear-gradient(-180deg, ").concat(theme("colors.white"), " 0%, ").concat(theme("colors.grey.50"), " 100%)\n      "),
+      backgroundPosition: "right ".concat(theme("spacing.4"), " center, 0 0"),
+      backgroundRepeat: "no-repeat",
+      borderRadius: theme("borderRadius.DEFAULT"),
+      border: "1px solid ".concat(theme("colors.grey.500")),
+      boxShadow: "0 1px 0 0 ".concat(theme("colors.shadow.5")),
+      "&::-moz-focus-inner, &:-moz-focusring": {
+        outline: "none",
+        color: "transparent",
+        textShadow: "0 0 0 ".concat(theme("colors.grey.900"))
+      },
+      "&:focus::-ms-value": {
+        color: theme("colors.grey.900")
+      },
+      "& > option": {
+        textShadow: "none",
+        "&:not(:checked)": {
+          color: theme("colors.grey.900")
+        },
+        "&:disabled": {
+          color: theme("colors.grey.300")
+        }
+      },
+      "&:hover": {
+        backgroundImage: "\n          ".concat(selectIconBG(theme("colors.grey.500")), ",\n          linear-gradient(-180deg, ").concat(theme("colors.grey.50"), " 0%, ").concat(theme("colors.grey.100"), " 100%)\n        "),
+        borderColor: theme("colors.grey.600")
+      },
+      "&:focus": {
+        backgroundImage: "\n          ".concat(selectIconBG(theme("colors.grey.500")), ",\n          linear-gradient(-180deg, ").concat(theme("colors.white"), " 0%, ").concat(theme("colors.grey.100"), " 100%)\n        "),
+        borderColor: theme("colors.accent.600"),
+        boxShadow: "\n          0 0 0 1px ".concat(theme("colors.accent.600"), ",\n          0 2px 0 0 ").concat(theme("colors.shadow.5"), "\n        ")
+      },
+      "&:disabled": {
+        cursor: "not-allowed",
+        color: theme("colors.grey.300"),
+        backgroundImage: "\n          ".concat(selectIconBG(theme("colors.grey.300")), ",\n          linear-gradient(-180deg, ").concat(theme("colors.white"), " 0%, ").concat(theme("colors.grey.100"), " 100%)\n        "),
+        borderColor: disabledColor(theme("colors.grey.200")),
+        boxShadow: "none"
+      }
+    },
+    ".select-input-small": {
+      height: theme("spacing.8"),
+      backgroundSize: "8px, auto"
+    },
+    ".select-input-medium": {
+      height: theme("spacing.10"),
+      backgroundSize: "10px, auto"
+    },
+    ".select-input-large": {
+      height: theme("spacing.12"),
+      backgroundSize: "12px, auto"
+    }
+  });
+});
+export default selectPlugin;

package/esm/Select/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Select";
+export { default } from "./Select";

package/esm/Select/index.js

@@ -0,0 +1,2 @@
+export * from "./Select";
+export { default } from "./Select";

package/esm/Separator/Separator.d.ts

@@ -0,0 +1,9 @@
+import * as RadixSeparator from "@radix-ui/react-separator";
+import type { VFC } from "react";
+export interface SeparatorProps {
+    className?: string;
+    interactive?: boolean;
+    orientation?: RadixSeparator.SeparatorProps["orientation"];
+}
+export declare const Separator: VFC<SeparatorProps>;
+export default Separator;

package/esm/Separator/Separator.js

@@ -0,0 +1,29 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+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) { _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 RadixSeparator from "@radix-ui/react-separator";
+import cx from "clsx";
+import stl from "../styles/helpers/satellitePrefixer";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var Separator = function Separator(_ref) {
+  var className = _ref.className,
+    interactive = _ref.interactive,
+    _ref$orientation = _ref.orientation,
+    orientation = _ref$orientation === void 0 ? "horizontal" : _ref$orientation;
+  var interactiveProps = interactive ? {
+    decorative: false,
+    tabIndex: 0,
+    "aria-valuemax": 100,
+    "aria-valuemin": 0,
+    "aria-valuenow": 50
+  } : {
+    decorative: true
+  };
+  return /*#__PURE__*/_jsx(RadixSeparator.Root, _objectSpread({
+    className: cx(stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["separator"]))), className, interactive && stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["interactive"])))),
+    orientation: orientation
+  }, interactiveProps));
+};
+export default Separator;

package/esm/Separator/Separator.tailwind.d.ts

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

package/esm/Separator/Separator.tailwind.js

@@ -0,0 +1,53 @@
+import _plugin from "tailwindcss/plugin";
+// @ts-check
+var plugin = _plugin;
+var separatorPlugin = plugin(function (_ref) {
+  var addComponents = _ref.addComponents,
+    theme = _ref.theme;
+  var margin = theme("spacing.4");
+  addComponents({
+    ".separator": {
+      backgroundColor: theme("colors.grey.200"),
+      "&.interactive:hover": {
+        backgroundColor: theme("colors.xenon.600")
+      },
+      "&.interactive:focus": {
+        backgroundColor: theme("colors.xenon.600"),
+        outline: "solid 1px ".concat(theme("colors.xenon.600"))
+      },
+      '&[data-orientation="horizontal"]': {
+        height: "1px",
+        width: "100%",
+        margin: "".concat(margin, " 0"),
+        "&.interactive": {
+          position: "relative",
+          "&::after": {
+            position: "absolute",
+            right: "0px",
+            left: "0px",
+            top: "-10px",
+            height: "20px",
+            content: '" "'
+          }
+        }
+      },
+      '&[data-orientation="vertical"]': {
+        height: "100%",
+        width: "1px",
+        margin: "0 ".concat(margin),
+        "&.interactive": {
+          position: "relative",
+          "&::after": {
+            position: "absolute",
+            width: "20px",
+            left: "-10px",
+            top: "0px",
+            bottom: "0px",
+            content: '" "'
+          }
+        }
+      }
+    }
+  });
+});
+export default separatorPlugin;

package/esm/Separator/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Separator";
+export { default } from "./Separator";

package/esm/Separator/index.js

@@ -0,0 +1,2 @@
+export * from "./Separator";
+export { default } from "./Separator";

package/esm/Sidebar/Sidebar.d.ts

@@ -0,0 +1,36 @@
+import type { ReactNode, VFC } from "react";
+import type { SidebarLocale, SidebarLocation, SidebarVariant } from "./types";
+export interface SidebarProps {
+    id?: string;
+    /** @ignore */
+    className?: string;
+    label?: string;
+    locale?: SidebarLocale;
+    collapsed?: boolean;
+    /**
+     * As the name of the variants imply,
+     * - `primary` should be used for your first level of navigation
+     * - `secondary` should be used for your second level of navigation
+     */
+    variant?: SidebarVariant;
+    /**
+     * Used to determine whether a link should be highlighted as "active"
+     * Ideally only one link should be shown as active at any given time.
+     *
+     * @example <caption>with a location of /foo/bar</caption>
+     * isLinkActive('/foo', location) // returns true
+     *
+     * @example <caption>with a location of /bar</caption>
+     * isLinkActive('/foo', location) // returns false
+     *
+     * */
+    isLinkActive?: (href: string, location: SidebarLocation) => boolean;
+    /**
+     * location is used in conjunction with `isLinkActive` to display active links properly.
+     * It is injected from outside so that it can work with different router libraries and
+     * re-render when necessary.
+     */
+    location: SidebarLocation;
+    children?: ReactNode;
+}
+export declare const Sidebar: VFC<SidebarProps>;

package/esm/Sidebar/Sidebar.js

@@ -0,0 +1,54 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 { useCallback } from "react";
+import { useLocale } from "../Satellite";
+import ScrollIndicator from "../ScrollIndicator";
+import stl from "../styles/helpers/satellitePrefixer";
+import matchLocation from "../utils/matchLocation";
+import { SidebarContext } from "./SidebarContext";
+import { jsx as _jsx } from "react/jsx-runtime";
+var DEFAULT_SIDEBAR_LOCALE = {
+  primarySidebarLabel: "Primary Navigation Sidebar",
+  secondarySidebarLabel: "Secondary Navigation Sidebar"
+};
+export var Sidebar = function Sidebar(_ref) {
+  var id = _ref.id,
+    className = _ref.className,
+    labelProp = _ref.label,
+    localeProp = _ref.locale,
+    _ref$variant = _ref.variant,
+    variant = _ref$variant === void 0 ? "primary" : _ref$variant,
+    _ref$collapsed = _ref.collapsed,
+    collapsed = _ref$collapsed === void 0 ? false : _ref$collapsed,
+    _ref$isLinkActive = _ref.isLinkActive,
+    isLinkActiveProp = _ref$isLinkActive === void 0 ? matchLocation : _ref$isLinkActive,
+    location = _ref.location,
+    children = _ref.children;
+  var isLinkActive = useCallback(function (href) {
+    return isLinkActiveProp(href, location);
+  }, [isLinkActiveProp, location]);
+  var contextLocale = useLocale("sidebar");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_SIDEBAR_LOCALE), contextLocale), localeProp);
+  var label = typeof labelProp === "string" ? labelProp : variant === "primary" ? locale.primarySidebarLabel : locale.secondarySidebarLabel;
+  return /*#__PURE__*/_jsx(SidebarContext.Provider, {
+    value: {
+      collapsed: collapsed,
+      variant: variant,
+      isLinkActive: isLinkActive
+    },
+    children: /*#__PURE__*/_jsx("aside", {
+      id: id,
+      "aria-label": label,
+      className: cx(stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n            display-body border-r border-grey-200/50\n            ", "\n            ", "\n          "])), collapsed ? "w-14" : "w-56", variant === "primary" ? "bg-grey-100" : "bg-white"), className),
+      children: /*#__PURE__*/_jsx(ScrollIndicator, {
+        wrapperClassName: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["h-full -mr-px"]))),
+        className: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["relative px-3 pb-7 flex flex-col no-scrollbar overflow-x-hidden"]))),
+        children: children
+      })
+    })
+  });
+};

package/esm/Sidebar/SidebarButtonLink.d.ts

@@ -0,0 +1,20 @@
+import type { MouseEventHandler, ReactNode, VFC } from "react";
+import type { IconComponentType } from "../types";
+export declare type SidebarButtonLinkIcon = IconComponentType | {
+    active: IconComponentType;
+    inactive: IconComponentType;
+};
+export interface SidebarButtonLinkProps {
+    id?: string;
+    icon: SidebarButtonLinkIcon;
+    href: string;
+    onClick?: MouseEventHandler<HTMLAnchorElement>;
+    disabled?: boolean;
+    /**
+     * Alternative content for the tooltip.
+     * @default children
+     */
+    tooltipContent?: ReactNode;
+    children: ReactNode;
+}
+export declare const SidebarButtonLink: VFC<SidebarButtonLinkProps>;

package/esm/Sidebar/SidebarButtonLink.js

@@ -0,0 +1,78 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+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 { useState } from "react";
+import { ExternalLink } from "react-feather";
+import stl from "../styles/helpers/satellitePrefixer";
+import { TooltipWrapper } from "../Tooltip";
+import useLinkProps from "../utils/useLinkProps";
+import { useSidebarContext } from "./SidebarContext";
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+var Tooltip = function Tooltip(_ref) {
+  var content = _ref.content,
+    children = _ref.children;
+  return /*#__PURE__*/_jsx(TooltipWrapper, {
+    side: "right",
+    sideOffset: 24,
+    delay: 0,
+    hideDelay: 0,
+    content: content,
+    interactive: false,
+    children: children
+  });
+};
+export var SidebarButtonLink = function SidebarButtonLink(props) {
+  var id = props.id,
+    icon = props.icon,
+    href = props.href,
+    disabled = props.disabled,
+    children = props.children;
+  var _useSidebarContext = useSidebarContext(),
+    isLinkActive = _useSidebarContext.isLinkActive,
+    collapsed = _useSidebarContext.collapsed;
+  var linkProps = useLinkProps(props);
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    isInteractedWith = _useState2[0],
+    setIsInteractedWith = _useState2[1];
+  var isExternalLink = linkProps.target === "_blank";
+  var isActive = !disabled && !isExternalLink && isLinkActive(href);
+  var showColors = !disabled && (isActive || isInteractedWith);
+  var Icon = "active" in icon ? showColors ? icon.active : icon.inactive : icon;
+  var tooltipContent = "tooltipContent" in props ? props.tooltipContent : children;
+  return /*#__PURE__*/_jsx(Tooltip, {
+    content: collapsed ? tooltipContent : null,
+    children: /*#__PURE__*/_jsxs("a", _objectSpread(_objectSpread({}, linkProps), {}, {
+      id: id,
+      onMouseEnter: function onMouseEnter() {
+        return setIsInteractedWith(true);
+      },
+      onFocus: function onFocus() {
+        return setIsInteractedWith(true);
+      },
+      onMouseLeave: function onMouseLeave() {
+        return setIsInteractedWith(false);
+      },
+      onBlur: function onBlur() {
+        return setIsInteractedWith(false);
+      },
+      className: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n          h-8 min-w-8 w-full rounded\n          flex items-center space-x-3\n          border border-transparent\n          display-body\n          hover:no-underline focus:no-underline\n          ", "\n          ", "\n          ", "\n          ", "\n        "])), disabled ? "cursor-not-allowed opacity-70" : "focus:border-grey-500", isActive ? "shadow-z100" : !disabled && "hover:border-grey-200", isActive && "bg-gradient-to-b from-white to-grey-50", collapsed ? "pl-2" : "px-2"),
+      "aria-current": isActive,
+      children: [/*#__PURE__*/_jsx(Icon, {
+        className: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["", " ml-[-3px] shrink-0"])), showColors ? "text-accent-600" : "text-grey-400"),
+        height: 20,
+        width: 20
+      }), /*#__PURE__*/_jsx("span", {
+        className: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n            truncate\n            ", "\n            ", "\n            ", "\n          "])), collapsed && "sr-only", showColors ? "text-accent-600" : "typo-subdued", isActive && "font-bold"),
+        children: children
+      }), isExternalLink && !collapsed && /*#__PURE__*/_jsx(ExternalLink, {
+        className: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["", " !ml-1 shrink-0"])), showColors ? "text-accent-600" : "typo-subdued"),
+        size: "1em"
+      })]
+    }))
+  });
+};

package/esm/Sidebar/SidebarContext.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { SidebarVariant } from "./types";
+export declare type SidebarContextType = {
+    variant: SidebarVariant;
+    collapsed: boolean;
+    isLinkActive: (href: string) => boolean;
+};
+export declare const SidebarContext: import("react").Context<SidebarContextType | null>;
+export declare const useSidebarContext: () => SidebarContextType;

package/esm/Sidebar/SidebarContext.js

@@ -0,0 +1,9 @@
+import { createContext, useContext } from "react";
+export var SidebarContext = /*#__PURE__*/createContext(null);
+export var useSidebarContext = function useSidebarContext() {
+  var context = useContext(SidebarContext);
+  if (!context) {
+    throw new Error("useSidebarContext used outside of Sidebar");
+  }
+  return context;
+};

package/esm/Sidebar/SidebarHeader.d.ts

@@ -0,0 +1,7 @@
+import type { ReactNode, VFC } from "react";
+export declare type SidebarHeaderProps = {
+    /** @ignore */
+    className?: string;
+    children?: ReactNode;
+};
+export declare const SidebarHeader: VFC<SidebarHeaderProps>;

package/esm/Sidebar/SidebarHeader.js

@@ -0,0 +1,13 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _templateObject;
+import cx from "clsx";
+import stl from "../styles/helpers/satellitePrefixer";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var SidebarHeader = function SidebarHeader(_ref) {
+  var className = _ref.className,
+    children = _ref.children;
+  return /*#__PURE__*/_jsx("header", {
+    className: cx(stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["h-[72px] shrink-0 border-b border-grey-200/50"]))), className),
+    children: children
+  });
+};

package/esm/Sidebar/SidebarHeading.d.ts

@@ -0,0 +1,8 @@
+import type { ReactNode, VFC } from "react";
+export declare type SidebarHeadingProps = {
+    id?: string;
+    /** @ignore */
+    className?: string;
+    children: ReactNode;
+};
+export declare const SidebarHeading: VFC<SidebarHeadingProps>;