@algolia/satellite 1.0.0-beta.171 → 1.0.0-beta.173

package/esm/Tooltip/OverflowTooltipWrapper.d.ts

@@ -2,4 +2,9 @@ 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/esm/Tooltip/OverflowTooltipWrapper.js

@@ -14,6 +14,11 @@ 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);

package/esm/Tooltip/Tooltip.d.ts

@@ -4,21 +4,9 @@ export interface TooltipProps extends DetailedHTMLProps<HTMLAttributes<HTMLDivEl
     variant?: TooltipVariant;
 }
 /**
- * Tooltips are floating labels that briefly explain the function of a user interface element. They can be triggered when merchants hover, focus, tap, or click.
+ * 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.
  *
- * Use tooltips to identify or add a small amount of information to an element. Typically, tooltips are used to help users understand the meaning or purpose of icons, showing the full version of truncated text, or displaying the alt text for an image. Tooltips do not receive input focus.
- * When writing tooltips, be short and concise. When you need to add more than a single line of extra information, consider using inline dialogs instead.
- *
- * The position of tooltips is flexible and will change depending on how close the element is to the edge of the screen.
- *
- * ## Best practices
- * Tooltips should:
- *
- * - Provide useful, additional information or clarification.
- * - Succinctly describe or expand on the element they point to.
- * - Not be used to communicate critical information, including errors in forms or other interaction feedback.
- * - Not contain any links, inputs, or buttons.
- * - Be used sparingly. If you're building something that requires a lot of tooltips, work on clarifying the design and the language in the experience.
+ * See the [Tooltip documentation page](https://satellite.algolia.com/components/overlay/tooltip) for more information.
  */
 export declare const Tooltip: import("react").ForwardRefExoticComponent<Pick<TooltipProps, "dir" | "slot" | "style" | "title" | "children" | "id" | "variant" | "className" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "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>>;
 export default Tooltip;

package/esm/Tooltip/Tooltip.js

@@ -15,21 +15,9 @@ var VARIANT_CLASSNAMES = {
 };
 
 /**
- * Tooltips are floating labels that briefly explain the function of a user interface element. They can be triggered when merchants hover, focus, tap, or click.
+ * 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.
  *
- * Use tooltips to identify or add a small amount of information to an element. Typically, tooltips are used to help users understand the meaning or purpose of icons, showing the full version of truncated text, or displaying the alt text for an image. Tooltips do not receive input focus.
- * When writing tooltips, be short and concise. When you need to add more than a single line of extra information, consider using inline dialogs instead.
- *
- * The position of tooltips is flexible and will change depending on how close the element is to the edge of the screen.
- *
- * ## Best practices
- * Tooltips should:
- *
- * - Provide useful, additional information or clarification.
- * - Succinctly describe or expand on the element they point to.
- * - Not be used to communicate critical information, including errors in forms or other interaction feedback.
- * - Not contain any links, inputs, or buttons.
- * - Be used sparingly. If you're building something that requires a lot of tooltips, work on clarifying the design and the language in the experience.
+ * 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,

package/esm/Tooltip/TooltipWrapper.d.ts

@@ -11,4 +11,9 @@ export interface TooltipWrapperProps extends TooltipWrapperBaseProps {
      */
     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>;

package/esm/Tooltip/TooltipWrapper.js

@@ -10,6 +10,11 @@ import TooltipInternal from "./Tooltip";
 import { Fragment as _Fragment } from "react/jsx-runtime";
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * 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 var TooltipWrapper = function TooltipWrapper(_ref) {
   var show = _ref.show,
     _ref$delay = _ref.delay,

package/esm/UserContent/UserContent.d.ts

@@ -5,5 +5,10 @@ export interface UserContentProps {
     className?: string;
     content?: string;
 }
+/**
+ * The `UserContent` component is used to style user generated content that comes as HTML, often from a markdown source.
+ *
+ * See the [User Content documentation page](https://satellite.algolia.com/layouts/user-content) for more information.
+ */
 export declare const UserContent: VFC<UserContentProps>;
 export default UserContent;

package/esm/UserContent/UserContent.js

@@ -3,6 +3,11 @@ var _templateObject;
 import cx from "clsx";
 import stl from "../styles/helpers/satellitePrefixer";
 import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * The `UserContent` component is used to style user generated content that comes as HTML, often from a markdown source.
+ *
+ * See the [User Content documentation page](https://satellite.algolia.com/layouts/user-content) for more information.
+ */
 export var UserContent = function UserContent(_ref) {
   var className = _ref.className,
     content = _ref.content,

package/esm/index.d.ts

@@ -30,6 +30,7 @@ export * from "./Link";
 export * from "./Medallion";
 export * from "./Modal";
 export * from "./Pagination";
+export * from "./Popover";
 export * from "./ProgressBar";
 export * from "./ProgressSpinner";
 export * from "./RadioGroup";

package/esm/index.js

@@ -30,6 +30,7 @@ export * from "./Link";
 export * from "./Medallion";
 export * from "./Modal";
 export * from "./Pagination";
+export * from "./Popover";
 export * from "./ProgressBar";
 export * from "./ProgressSpinner";
 export * from "./RadioGroup";

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@algolia/satellite",
-  "version": "1.0.0-beta.171",
+  "version": "1.0.0-beta.173",
   "description": "Algolia design system React components",
+  "sideEffects": false,
   "scripts": {
     "clean": "rimraf dist",
     "prebuild": "yarn clean",