@algolia/satellite 1.0.0-beta.170 → 1.0.0-beta.172
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/AnnouncementBadge/AnnouncementBadge.d.ts +5 -0
- package/cjs/AnnouncementBadge/AnnouncementBadge.js +6 -0
- package/cjs/AutoComplete/AutoComplete.d.ts +2 -13
- package/cjs/AutoComplete/AutoComplete.js +52 -67
- package/cjs/AutoComplete/utils.d.ts +1 -1
- package/cjs/Avatars/ApplicationAvatar.d.ts +5 -1
- package/cjs/Avatars/ApplicationAvatar.js +5 -1
- package/cjs/Avatars/UserAvatar.d.ts +5 -1
- package/cjs/Avatars/UserAvatar.js +5 -1
- package/cjs/Badge/Badge.d.ts +2 -12
- package/cjs/Badge/Badge.js +2 -12
- package/cjs/Banners/Alert/Alert.d.ts +3 -48
- package/cjs/Banners/Alert/Alert.js +3 -48
- package/cjs/Banners/BigBertha/BigBertha.d.ts +3 -31
- package/cjs/Banners/BigBertha/BigBertha.js +3 -31
- package/cjs/Banners/Promote/Promote.d.ts +3 -26
- package/cjs/Banners/Promote/Promote.js +3 -26
- package/cjs/Button/Button.d.ts +2 -11
- package/cjs/Button/Button.js +2 -11
- package/cjs/Button/ButtonGroup.d.ts +3 -3
- package/cjs/Button/ButtonGroup.js +3 -3
- package/cjs/Button/IconButton.d.ts +2 -2
- package/cjs/Button/IconButton.js +2 -2
- package/cjs/Card/Card.d.ts +5 -1
- package/cjs/Card/Card.js +5 -1
- package/cjs/Checkbox/Checkbox.d.ts +2 -3
- package/cjs/Checkbox/Checkbox.js +2 -3
- package/cjs/DatePicker/DatePicker/DatePicker.d.ts +5 -0
- package/cjs/DatePicker/DatePicker/DatePicker.js +5 -0
- package/cjs/DatePicker/DateRangePicker/DateRangePicker.d.ts +5 -0
- package/cjs/DatePicker/DateRangePicker/DateRangePicker.js +6 -0
- package/cjs/Dropdown/Dropdown.d.ts +3 -8
- package/cjs/Dropdown/Dropdown.js +3 -8
- package/cjs/Dropzone/Dropzone.d.ts +5 -0
- package/cjs/Dropzone/Dropzone.js +6 -0
- package/cjs/EmptyState/EmptyState.d.ts +2 -21
- package/cjs/EmptyState/EmptyState.js +2 -21
- package/cjs/Field/Field.d.ts +2 -31
- package/cjs/Field/Field.js +2 -31
- package/cjs/Flag/Flag.d.ts +5 -0
- package/cjs/Flag/Flag.js +6 -0
- package/cjs/FlexGrid/FlexGrid.d.ts +5 -0
- package/cjs/FlexGrid/FlexGrid.js +6 -0
- package/cjs/HelpUnderline/HelpUnderline.d.ts +5 -0
- package/cjs/HelpUnderline/HelpUnderline.js +5 -0
- package/cjs/Input/Input.d.ts +2 -4
- package/cjs/Input/Input.js +2 -4
- package/cjs/Insert/Insert.d.ts +3 -29
- package/cjs/Insert/Insert.js +3 -29
- package/cjs/KeyboardKey/KeyboardKey.d.ts +5 -0
- package/cjs/KeyboardKey/KeyboardKey.js +5 -0
- package/cjs/Link/ButtonLink.d.ts +5 -0
- package/cjs/Link/ButtonLink.js +5 -0
- package/cjs/Link/IconButtonLink.d.ts +5 -0
- package/cjs/Link/IconButtonLink.js +5 -0
- package/cjs/Link/Link.d.ts +5 -0
- package/cjs/Link/Link.js +5 -0
- package/cjs/Medallion/Medallion.d.ts +5 -0
- package/cjs/Medallion/Medallion.js +6 -0
- package/cjs/Modal/Modal.d.ts +5 -0
- package/cjs/Modal/Modal.js +6 -0
- package/cjs/Pagination/CompactPagination/CompactPagination.d.ts +5 -0
- package/cjs/Pagination/CompactPagination/CompactPagination.js +6 -0
- package/cjs/Pagination/DotPagination/DotPagination.d.ts +5 -0
- package/cjs/Pagination/DotPagination/DotPagination.js +5 -0
- package/cjs/Pagination/Pagination/Pagination.d.ts +2 -4
- package/cjs/Pagination/Pagination/Pagination.js +2 -4
- package/cjs/Popover/Popover.d.ts +5 -0
- package/cjs/Popover/Popover.js +6 -0
- package/cjs/ProgressBar/ProgressBar.d.ts +1 -1
- package/cjs/ProgressBar/ProgressBar.js +1 -1
- package/cjs/ProgressSpinner/ProgressSpinner.d.ts +5 -0
- package/cjs/ProgressSpinner/ProgressSpinner.js +27 -19
- package/cjs/RadioGroup/RadioGroup.d.ts +2 -12
- package/cjs/RadioGroup/RadioGroup.js +2 -12
- package/cjs/RangeSlider/RangeSlider.d.ts +2 -4
- package/cjs/RangeSlider/RangeSlider.js +2 -4
- package/cjs/ScrollIndicator/ScrollIndicator.d.ts +5 -0
- package/cjs/ScrollIndicator/ScrollIndicator.js +6 -0
- package/cjs/Select/Select.d.ts +2 -5
- package/cjs/Select/Select.js +2 -5
- package/cjs/Separator/Separator.d.ts +5 -0
- package/cjs/Separator/Separator.js +5 -0
- package/cjs/Sidebar/Sidebar.d.ts +5 -0
- package/cjs/Sidebar/Sidebar.js +6 -0
- package/cjs/Switch/Switch.d.ts +5 -0
- package/cjs/Switch/Switch.js +5 -0
- package/cjs/Tables/DataTable/DataTable.d.ts +2 -16
- package/cjs/Tables/DataTable/DataTable.js +2 -16
- package/cjs/Tables/Table/Table.d.ts +2 -16
- package/cjs/Tables/Table/Table.js +2 -16
- package/cjs/Tabs/LinkTabs.d.ts +2 -25
- package/cjs/Tabs/LinkTabs.js +2 -25
- package/cjs/Tag/Tag.d.ts +2 -19
- package/cjs/Tag/Tag.js +2 -19
- package/cjs/TextArea/TextArea.d.ts +5 -0
- package/cjs/TextArea/TextArea.js +5 -0
- package/cjs/TextWrap/TextWrap.d.ts +5 -0
- package/cjs/TextWrap/TextWrap.js +6 -0
- package/cjs/Toggle/Toggle.d.ts +2 -3
- package/cjs/Toggle/Toggle.js +2 -3
- package/cjs/Tooltip/OverflowTooltipWrapper.d.ts +5 -0
- package/cjs/Tooltip/OverflowTooltipWrapper.js +5 -0
- package/cjs/Tooltip/Tooltip.d.ts +2 -14
- package/cjs/Tooltip/Tooltip.js +2 -14
- package/cjs/Tooltip/TooltipWrapper.d.ts +5 -0
- package/cjs/Tooltip/TooltipWrapper.js +5 -0
- package/cjs/UserContent/UserContent.d.ts +5 -0
- package/cjs/UserContent/UserContent.js +5 -0
- package/esm/AnnouncementBadge/AnnouncementBadge.d.ts +5 -0
- package/esm/AnnouncementBadge/AnnouncementBadge.js +6 -0
- package/esm/AutoComplete/AutoComplete.d.ts +2 -13
- package/esm/AutoComplete/AutoComplete.js +52 -68
- package/esm/AutoComplete/utils.d.ts +1 -1
- package/esm/Avatars/ApplicationAvatar.d.ts +5 -1
- package/esm/Avatars/ApplicationAvatar.js +5 -1
- package/esm/Avatars/UserAvatar.d.ts +5 -1
- package/esm/Avatars/UserAvatar.js +5 -1
- package/esm/Badge/Badge.d.ts +2 -12
- package/esm/Badge/Badge.js +2 -12
- package/esm/Banners/Alert/Alert.d.ts +3 -48
- package/esm/Banners/Alert/Alert.js +3 -48
- package/esm/Banners/BigBertha/BigBertha.d.ts +3 -31
- package/esm/Banners/BigBertha/BigBertha.js +3 -31
- package/esm/Banners/Promote/Promote.d.ts +3 -26
- package/esm/Banners/Promote/Promote.js +3 -26
- package/esm/Button/Button.d.ts +2 -11
- package/esm/Button/Button.js +2 -11
- package/esm/Button/ButtonGroup.d.ts +3 -3
- package/esm/Button/ButtonGroup.js +3 -3
- package/esm/Button/IconButton.d.ts +2 -2
- package/esm/Button/IconButton.js +2 -2
- package/esm/Card/Card.d.ts +5 -1
- package/esm/Card/Card.js +5 -1
- package/esm/Checkbox/Checkbox.d.ts +2 -3
- package/esm/Checkbox/Checkbox.js +2 -3
- package/esm/DatePicker/DatePicker/DatePicker.d.ts +5 -0
- package/esm/DatePicker/DatePicker/DatePicker.js +5 -0
- package/esm/DatePicker/DateRangePicker/DateRangePicker.d.ts +5 -0
- package/esm/DatePicker/DateRangePicker/DateRangePicker.js +6 -0
- package/esm/Dropdown/Dropdown.d.ts +3 -8
- package/esm/Dropdown/Dropdown.js +3 -8
- package/esm/Dropzone/Dropzone.d.ts +5 -0
- package/esm/Dropzone/Dropzone.js +6 -0
- package/esm/EmptyState/EmptyState.d.ts +2 -21
- package/esm/EmptyState/EmptyState.js +2 -21
- package/esm/Field/Field.d.ts +2 -31
- package/esm/Field/Field.js +2 -31
- package/esm/Flag/Flag.d.ts +5 -0
- package/esm/Flag/Flag.js +6 -0
- package/esm/FlexGrid/FlexGrid.d.ts +5 -0
- package/esm/FlexGrid/FlexGrid.js +6 -0
- package/esm/HelpUnderline/HelpUnderline.d.ts +5 -0
- package/esm/HelpUnderline/HelpUnderline.js +5 -0
- package/esm/Input/Input.d.ts +2 -4
- package/esm/Input/Input.js +2 -4
- package/esm/Insert/Insert.d.ts +3 -29
- package/esm/Insert/Insert.js +3 -29
- package/esm/KeyboardKey/KeyboardKey.d.ts +5 -0
- package/esm/KeyboardKey/KeyboardKey.js +5 -0
- package/esm/Link/ButtonLink.d.ts +5 -0
- package/esm/Link/ButtonLink.js +5 -0
- package/esm/Link/IconButtonLink.d.ts +5 -0
- package/esm/Link/IconButtonLink.js +5 -0
- package/esm/Link/Link.d.ts +5 -0
- package/esm/Link/Link.js +5 -0
- package/esm/Medallion/Medallion.d.ts +5 -0
- package/esm/Medallion/Medallion.js +6 -0
- package/esm/Modal/Modal.d.ts +5 -0
- package/esm/Modal/Modal.js +6 -0
- package/esm/Pagination/CompactPagination/CompactPagination.d.ts +5 -0
- package/esm/Pagination/CompactPagination/CompactPagination.js +6 -0
- package/esm/Pagination/DotPagination/DotPagination.d.ts +5 -0
- package/esm/Pagination/DotPagination/DotPagination.js +5 -0
- package/esm/Pagination/Pagination/Pagination.d.ts +2 -4
- package/esm/Pagination/Pagination/Pagination.js +2 -4
- package/esm/Popover/Popover.d.ts +5 -0
- package/esm/Popover/Popover.js +6 -0
- package/esm/ProgressBar/ProgressBar.d.ts +1 -1
- package/esm/ProgressBar/ProgressBar.js +1 -1
- package/esm/ProgressSpinner/ProgressSpinner.d.ts +5 -0
- package/esm/ProgressSpinner/ProgressSpinner.js +27 -19
- package/esm/RadioGroup/RadioGroup.d.ts +2 -12
- package/esm/RadioGroup/RadioGroup.js +2 -12
- package/esm/RangeSlider/RangeSlider.d.ts +2 -4
- package/esm/RangeSlider/RangeSlider.js +2 -4
- package/esm/ScrollIndicator/ScrollIndicator.d.ts +5 -0
- package/esm/ScrollIndicator/ScrollIndicator.js +6 -0
- package/esm/Select/Select.d.ts +2 -5
- package/esm/Select/Select.js +2 -5
- package/esm/Separator/Separator.d.ts +5 -0
- package/esm/Separator/Separator.js +5 -0
- package/esm/Sidebar/Sidebar.d.ts +5 -0
- package/esm/Sidebar/Sidebar.js +6 -0
- package/esm/Switch/Switch.d.ts +5 -0
- package/esm/Switch/Switch.js +5 -0
- package/esm/Tables/DataTable/DataTable.d.ts +2 -16
- package/esm/Tables/DataTable/DataTable.js +2 -16
- package/esm/Tables/Table/Table.d.ts +2 -16
- package/esm/Tables/Table/Table.js +2 -16
- package/esm/Tabs/LinkTabs.d.ts +2 -25
- package/esm/Tabs/LinkTabs.js +2 -25
- package/esm/Tag/Tag.d.ts +2 -19
- package/esm/Tag/Tag.js +2 -19
- package/esm/TextArea/TextArea.d.ts +5 -0
- package/esm/TextArea/TextArea.js +5 -0
- package/esm/TextWrap/TextWrap.d.ts +5 -0
- package/esm/TextWrap/TextWrap.js +6 -0
- package/esm/Toggle/Toggle.d.ts +2 -3
- package/esm/Toggle/Toggle.js +2 -3
- package/esm/Tooltip/OverflowTooltipWrapper.d.ts +5 -0
- package/esm/Tooltip/OverflowTooltipWrapper.js +5 -0
- package/esm/Tooltip/Tooltip.d.ts +2 -14
- package/esm/Tooltip/Tooltip.js +2 -14
- package/esm/Tooltip/TooltipWrapper.d.ts +5 -0
- package/esm/Tooltip/TooltipWrapper.js +5 -0
- package/esm/UserContent/UserContent.d.ts +5 -0
- package/esm/UserContent/UserContent.js +5 -0
- package/package.json +1 -1
@@ -11,6 +11,7 @@ import { useEffect, useMemo, useRef, useState } from "react";
|
|
11
11
|
import { X } from "react-feather";
|
12
12
|
import { usePopper } from "react-popper";
|
13
13
|
import useMeasure from "react-use/lib/useMeasure";
|
14
|
+
import usePrevious from "react-use/lib/usePrevious";
|
14
15
|
import { Card } from "../Card";
|
15
16
|
import { ClickAwayContainer } from "../ClickAwayContainer";
|
16
17
|
import { useField } from "../Field";
|
@@ -25,7 +26,6 @@ import { DefaultOptionItem } from "./components/DefaultOptionItem";
|
|
25
26
|
import { DEFAULT_AUTOCOMPLETE_LOCALE, defaultCreateFromInputValue, filter, optionToString } from "./utils";
|
26
27
|
import { jsx as _jsx } from "react/jsx-runtime";
|
27
28
|
import { jsxs as _jsxs } from "react/jsx-runtime";
|
28
|
-
import { Fragment as _Fragment } from "react/jsx-runtime";
|
29
29
|
var MENU_POPPER_OPTIONS = {
|
30
30
|
strategy: "fixed",
|
31
31
|
placement: "bottom-start",
|
@@ -46,20 +46,9 @@ var updateRef = function updateRef(ref, value) {
|
|
46
46
|
};
|
47
47
|
|
48
48
|
/**
|
49
|
-
* Autocomplete
|
49
|
+
* The `Autocomplete` component enables users to search and select from a list using real-time input matching.
|
50
50
|
*
|
51
|
-
*
|
52
|
-
*
|
53
|
-
* ## Menu Size Variations
|
54
|
-
* - **Medium (default)**: the standard dropdown menu height for most use cases
|
55
|
-
* - **Large**: when numerous results should be displayed in the dropdown to ease selection
|
56
|
-
*
|
57
|
-
* ## Best practices
|
58
|
-
*
|
59
|
-
* - Provide an empty state if there is no result
|
60
|
-
* - Highlight letters in results matching the query
|
61
|
-
* - Provide matching results quickly
|
62
|
-
* - Style different data
|
51
|
+
* See the [Autocomplete documentation page](https://satellite.algolia.com/components/forms/autocomplete) for more information.
|
63
52
|
*/
|
64
53
|
export var AutoComplete = function AutoComplete(_ref) {
|
65
54
|
var localeProp = _ref.locale,
|
@@ -118,17 +107,12 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
118
107
|
_useState4 = _slicedToArray(_useState3, 2),
|
119
108
|
internalInputValue = _useState4[0],
|
120
109
|
setInternalInputValue = _useState4[1];
|
121
|
-
|
122
|
-
// See https://github.com/downshift-js/downshift/issues/1108
|
123
|
-
// as to why we manage the input value ourselves completely
|
124
|
-
var updateInputValue = function updateInputValue(value) {
|
125
|
-
setInternalInputValue(value);
|
126
|
-
onTextChange === null || onTextChange === void 0 || onTextChange(value);
|
127
|
-
};
|
110
|
+
var previousValue = usePrevious(value);
|
128
111
|
useEffect(function () {
|
129
112
|
if (multiple || typeof inputValueProp !== "undefined") return;
|
130
|
-
|
131
|
-
|
113
|
+
if (!Array.isArray(previousValue) && optionToString(previousValue) === optionToString(value)) return;
|
114
|
+
setInternalInputValue(optionToString(value));
|
115
|
+
}, [multiple, inputValueProp, previousValue, value]);
|
132
116
|
var inputValue = inputValueProp !== null && inputValueProp !== void 0 ? inputValueProp : internalInputValue;
|
133
117
|
var _useState5 = useState(null),
|
134
118
|
_useState6 = _slicedToArray(_useState5, 2),
|
@@ -227,11 +211,11 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
227
211
|
combobox.setHighlightedIndex(maxItems);
|
228
212
|
} else if (multiple) {
|
229
213
|
multipleSelection.addSelectedItem(selectedItem);
|
230
|
-
|
214
|
+
setInternalInputValue("");
|
231
215
|
setShowAllItems(false);
|
232
216
|
} else {
|
233
217
|
multipleSelection.setSelectedItems([selectedItem]);
|
234
|
-
|
218
|
+
setInternalInputValue(optionToString(selectedItem));
|
235
219
|
setShowAllItems(false);
|
236
220
|
}
|
237
221
|
break;
|
@@ -239,7 +223,7 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
239
223
|
case useCombobox.stateChangeTypes.InputKeyDownEscape:
|
240
224
|
{
|
241
225
|
if (!combobox.isOpen) {
|
242
|
-
|
226
|
+
setInternalInputValue("");
|
243
227
|
multipleSelection.setSelectedItems([]);
|
244
228
|
}
|
245
229
|
break;
|
@@ -256,10 +240,13 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
256
240
|
ref: inputRef,
|
257
241
|
autoFocus: autoFocus,
|
258
242
|
disabled: disabled,
|
243
|
+
// See https://github.com/downshift-js/downshift/issues/1108
|
244
|
+
// as to why we manage the input value ourselves completely
|
259
245
|
onChange: function onChange(evt) {
|
260
246
|
var _value, _menuPopper$update;
|
261
247
|
var newInputValue = (_value = evt.currentTarget.value) !== null && _value !== void 0 ? _value : "";
|
262
|
-
|
248
|
+
setInternalInputValue(newInputValue);
|
249
|
+
onTextChange === null || onTextChange === void 0 || onTextChange(newInputValue);
|
263
250
|
if (!multiple && value && !newInputValue) {
|
264
251
|
multipleSelection.setSelectedItems([]);
|
265
252
|
}
|
@@ -289,7 +276,7 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
289
276
|
newOption = _createFromInputValue2[0];
|
290
277
|
if (newOption && !newOption.disabled) {
|
291
278
|
multipleSelection.addSelectedItem(newOption);
|
292
|
-
|
279
|
+
setInternalInputValue("");
|
293
280
|
}
|
294
281
|
}
|
295
282
|
}
|
@@ -381,9 +368,8 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
381
368
|
}), showClearButton && /*#__PURE__*/_jsx("button", {
|
382
369
|
type: "button",
|
383
370
|
className: stl(_templateObject19 || (_templateObject19 = _taggedTemplateLiteral(["w-6 h-6 flex items-center justify-center text-grey-500"]))),
|
384
|
-
onClick: function onClick(
|
385
|
-
|
386
|
-
updateInputValue("");
|
371
|
+
onClick: function onClick() {
|
372
|
+
setInternalInputValue("");
|
387
373
|
multipleSelection.setSelectedItems([]);
|
388
374
|
},
|
389
375
|
"aria-label": locale.clearInputButton,
|
@@ -394,7 +380,7 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
394
380
|
})]
|
395
381
|
}), createPortal( /*#__PURE__*/_jsx(ClickAwayContainer, {
|
396
382
|
element: menuRef.current,
|
397
|
-
children: /*#__PURE__*/
|
383
|
+
children: /*#__PURE__*/_jsxs(Card, _objectSpread(_objectSpread({}, menuPopper.attributes), {}, {
|
398
384
|
className: cx(stl(_templateObject20 || (_templateObject20 = _taggedTemplateLiteral(["z-dropdown"]))), menuClassName),
|
399
385
|
style: _objectSpread(_objectSpread(_objectSpread({}, menuPopper.styles.popper), hideMenu && {
|
400
386
|
display: "none"
|
@@ -405,43 +391,41 @@ export var AutoComplete = function AutoComplete(_ref) {
|
|
405
391
|
ref: menuRef,
|
406
392
|
elevation: "300",
|
407
393
|
fullBleed: true,
|
408
|
-
children: hideMenu ? /*#__PURE__*/_jsx("div", _objectSpread({}, combobox.getMenuProps())) : /*#__PURE__*/
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
394
|
+
children: [hideMenu ? /*#__PURE__*/_jsx("div", _objectSpread({}, combobox.getMenuProps())) : items.length === 0 ? /*#__PURE__*/_jsx("div", _objectSpread(_objectSpread({}, combobox.getMenuProps({
|
395
|
+
className: stl(_templateObject21 || (_templateObject21 = _taggedTemplateLiteral(["min-h-10"])))
|
396
|
+
})), {}, {
|
397
|
+
children: /*#__PURE__*/_jsx("div", {
|
398
|
+
role: "option",
|
399
|
+
"aria-disabled": "true",
|
400
|
+
"aria-selected": "false",
|
401
|
+
children: emptyState !== null && emptyState !== void 0 ? emptyState : /*#__PURE__*/_jsx(AutoCompleteEmptyState, {
|
402
|
+
title: locale.emptyStateTitle
|
403
|
+
})
|
404
|
+
})
|
405
|
+
})) : /*#__PURE__*/_jsx(ScrollIndicator, {
|
406
|
+
className: menuSize === "large" ? stl(_templateObject22 || (_templateObject22 = _taggedTemplateLiteral(["max-h-96"]))) : stl(_templateObject23 || (_templateObject23 = _taggedTemplateLiteral(["max-h-64"]))),
|
407
|
+
children: /*#__PURE__*/_jsx("ul", _objectSpread(_objectSpread({}, combobox.getMenuProps()), {}, {
|
408
|
+
children: items.map(function (item, index) {
|
409
|
+
return /*#__PURE__*/_jsx("li", _objectSpread(_objectSpread({}, combobox.getItemProps({
|
410
|
+
item: item,
|
411
|
+
className: cx(stl(_templateObject24 || (_templateObject24 = _taggedTemplateLiteral(["autocomplete-result flex items-center min-h-10 px-4 cursor-pointer"]))), index === combobox.highlightedIndex && stl(_templateObject25 || (_templateObject25 = _taggedTemplateLiteral(["bg-grey-100"]))), item.disabled && stl(_templateObject26 || (_templateObject26 = _taggedTemplateLiteral(["cursor-not-allowed"]))))
|
412
|
+
})), {}, {
|
413
|
+
children: item.value === SHOW_ALL_ITEMS_ID ? /*#__PURE__*/_jsx("span", {
|
414
|
+
className: stl(_templateObject27 || (_templateObject27 = _taggedTemplateLiteral(["w-full py-2 truncate text-center text-grey-900"]))),
|
415
|
+
children: item.label
|
416
|
+
}, item.value) : /*#__PURE__*/_jsx(OptionItem, {
|
417
|
+
multiple: Boolean(multiple),
|
418
|
+
inputValue: inputValue,
|
419
|
+
highlighted: index === combobox.highlightedIndex,
|
420
|
+
option: item
|
421
|
+
})
|
422
|
+
}), String(item.value));
|
419
423
|
})
|
420
|
-
}))
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
item: item,
|
426
|
-
className: cx(stl(_templateObject24 || (_templateObject24 = _taggedTemplateLiteral(["autocomplete-result flex items-center min-h-10 px-4 cursor-pointer"]))), index === combobox.highlightedIndex && stl(_templateObject25 || (_templateObject25 = _taggedTemplateLiteral(["bg-grey-100"]))), item.disabled && stl(_templateObject26 || (_templateObject26 = _taggedTemplateLiteral(["cursor-not-allowed"]))))
|
427
|
-
})), {}, {
|
428
|
-
children: item.value === SHOW_ALL_ITEMS_ID ? /*#__PURE__*/_jsx("span", {
|
429
|
-
className: stl(_templateObject27 || (_templateObject27 = _taggedTemplateLiteral(["w-full py-2 truncate text-center text-grey-900"]))),
|
430
|
-
children: item.label
|
431
|
-
}, item.value) : /*#__PURE__*/_jsx(OptionItem, {
|
432
|
-
multiple: Boolean(multiple),
|
433
|
-
inputValue: inputValue,
|
434
|
-
highlighted: index === combobox.highlightedIndex,
|
435
|
-
option: item
|
436
|
-
})
|
437
|
-
}), String(item.value));
|
438
|
-
})
|
439
|
-
}))
|
440
|
-
}), !!menuFooter && /*#__PURE__*/_jsx("footer", {
|
441
|
-
className: stl(_templateObject28 || (_templateObject28 = _taggedTemplateLiteral(["flex items-center justify-center min-h-12 p-4 bg-grey-100 border-t border-grey-200 text-grey-600"]))),
|
442
|
-
children: menuFooter
|
443
|
-
})]
|
444
|
-
})
|
424
|
+
}))
|
425
|
+
}), !!menuFooter && /*#__PURE__*/_jsx("footer", {
|
426
|
+
className: stl(_templateObject28 || (_templateObject28 = _taggedTemplateLiteral(["flex items-center justify-center min-h-12 p-4 bg-grey-100 border-t border-grey-200 text-grey-600"]))),
|
427
|
+
children: menuFooter
|
428
|
+
})]
|
445
429
|
}))
|
446
430
|
}))]
|
447
431
|
})
|
@@ -3,6 +3,6 @@ export declare function isAutoCompleteMultiProps<T extends Option = Option>(prop
|
|
3
3
|
export declare const defaultCreateFromInputValue: <T extends Option = Option>(options: T[] | undefined, inputValue: string) => Option[];
|
4
4
|
export declare const caseInsensitiveCreateFromInputValue: <T extends Option = Option>(options: T[] | undefined, inputValue: string) => Option[];
|
5
5
|
export declare const DEFAULT_AUTOCOMPLETE_LOCALE: Required<AutoCompleteLocale>;
|
6
|
-
export declare const optionToString: (option: Option | null) => string;
|
6
|
+
export declare const optionToString: (option: Option | null | undefined) => string;
|
7
7
|
export declare function filter<T extends Option = Option>(options: T[], selectedItems: T[], itemValue: string): T[];
|
8
8
|
export declare function inputValueFromProps<T extends Option = Option>(props: AutoCompleteProps<T>): string;
|
@@ -8,6 +8,10 @@ export interface ApplicationAvatarProps {
|
|
8
8
|
/** @ignore */
|
9
9
|
className?: string;
|
10
10
|
}
|
11
|
-
/**
|
11
|
+
/**
|
12
|
+
* The `ApplicationAvatar` component is used as a visual representation of an application.
|
13
|
+
*
|
14
|
+
* See the [Application Avatar documentation page](https://satellite.algolia.com/components/images/application-avatar) for more information.
|
15
|
+
*/
|
12
16
|
export declare const ApplicationAvatar: VFC<ApplicationAvatarProps>;
|
13
17
|
export default ApplicationAvatar;
|
@@ -8,7 +8,11 @@ var SIZE_CLASSNAMES = {
|
|
8
8
|
small: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["w-4 h-4"]))),
|
9
9
|
medium: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["w-8 h-8"])))
|
10
10
|
};
|
11
|
-
/**
|
11
|
+
/**
|
12
|
+
* The `ApplicationAvatar` component is used as a visual representation of an application.
|
13
|
+
*
|
14
|
+
* See the [Application Avatar documentation page](https://satellite.algolia.com/components/images/application-avatar) for more information.
|
15
|
+
*/
|
12
16
|
export var ApplicationAvatar = function ApplicationAvatar(_ref) {
|
13
17
|
var className = _ref.className,
|
14
18
|
application = _ref.application,
|
@@ -15,6 +15,10 @@ export interface UserAvatarProps {
|
|
15
15
|
className?: string;
|
16
16
|
locale?: UserAvatarLocale;
|
17
17
|
}
|
18
|
-
/**
|
18
|
+
/**
|
19
|
+
* The `UserAvatar` component is used as a visual representation of a user.
|
20
|
+
*
|
21
|
+
* See the [User Avatar documentation page](https://satellite.algolia.com/components/images/user-avatar) for more information.
|
22
|
+
*/
|
19
23
|
export declare const UserAvatar: VFC<UserAvatarProps>;
|
20
24
|
export default UserAvatar;
|
@@ -13,7 +13,11 @@ import { jsxs as _jsxs } from "react/jsx-runtime";
|
|
13
13
|
var DEFAULT_LOCALE = {
|
14
14
|
fallbackText: "User's avatar"
|
15
15
|
};
|
16
|
-
/**
|
16
|
+
/**
|
17
|
+
* The `UserAvatar` component is used as a visual representation of a user.
|
18
|
+
*
|
19
|
+
* See the [User Avatar documentation page](https://satellite.algolia.com/components/images/user-avatar) for more information.
|
20
|
+
*/
|
17
21
|
export var UserAvatar = function UserAvatar(_ref) {
|
18
22
|
var _user$email;
|
19
23
|
var className = _ref.className,
|
package/esm/Badge/Badge.d.ts
CHANGED
@@ -15,19 +15,9 @@ declare type BadgeContentProps = {
|
|
15
15
|
};
|
16
16
|
export declare type BadgeProps = BaseBadgeProps & AtLeastOne<BadgeContentProps>;
|
17
17
|
/**
|
18
|
-
*
|
18
|
+
* The `Badge` component is a visual marker highlighting information or status. It enhances UI, indicates progress, and classifies data.
|
19
19
|
*
|
20
|
-
*
|
21
|
-
* - Bages usually come after a textual information or explanation
|
22
|
-
* - Don't use badges where traditional error messages (such as form validation) can be used instead
|
23
|
-
* - Don't use badges with combination of buttons
|
24
|
-
* - Badges are not interactive
|
25
|
-
*
|
26
|
-
* Do use
|
27
|
-
*
|
28
|
-
* - To indicate progress of an A/B test
|
29
|
-
* - To indicate problem with an index
|
30
|
-
* - To display numeric values for multiple items (similar to a "tag cloud")
|
20
|
+
* See the [Badge documentation page](https://satellite.algolia.com/components/feedback/badge) for more information.
|
31
21
|
*/
|
32
22
|
export declare const Badge: import("react").ForwardRefExoticComponent<BadgeProps & import("react").RefAttributes<HTMLSpanElement>>;
|
33
23
|
export default Badge;
|
package/esm/Badge/Badge.js
CHANGED
@@ -28,19 +28,9 @@ var SIZE_CLASSNAMES = {
|
|
28
28
|
};
|
29
29
|
|
30
30
|
/**
|
31
|
-
*
|
31
|
+
* The `Badge` component is a visual marker highlighting information or status. It enhances UI, indicates progress, and classifies data.
|
32
32
|
*
|
33
|
-
*
|
34
|
-
* - Bages usually come after a textual information or explanation
|
35
|
-
* - Don't use badges where traditional error messages (such as form validation) can be used instead
|
36
|
-
* - Don't use badges with combination of buttons
|
37
|
-
* - Badges are not interactive
|
38
|
-
*
|
39
|
-
* Do use
|
40
|
-
*
|
41
|
-
* - To indicate progress of an A/B test
|
42
|
-
* - To indicate problem with an index
|
43
|
-
* - To display numeric values for multiple items (similar to a "tag cloud")
|
33
|
+
* See the [Badge documentation page](https://satellite.algolia.com/components/feedback/badge) for more information.
|
44
34
|
*/
|
45
35
|
export var Badge = /*#__PURE__*/forwardRef(function (_ref, ref) {
|
46
36
|
var children = _ref.children,
|
@@ -25,54 +25,9 @@ export interface AlertProps {
|
|
25
25
|
children: ReactNode;
|
26
26
|
}
|
27
27
|
/**
|
28
|
-
*
|
29
|
-
|
30
|
-
*
|
31
|
-
* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A262266)
|
32
|
-
|
33
|
-
* ## Current Status
|
34
|
-
* - [x] Figma
|
35
|
-
* - [x] React
|
36
|
-
* - [ ] Documentation
|
37
|
-
|
38
|
-
* ## Component structure
|
39
|
-
* This component uses a common banner structure. It uses an icon that should match the intent of the message, an optional title _(Highly recommended)_, a short paragraph of text and optional buttons for follow up actions. The `Alert` is dismissible by default, to do so a cross icon is displayed on the top-right corner.
|
40
|
-
|
41
|
-
* ## Guidelines
|
42
|
-
* ### How to use it?
|
43
|
-
* Use the `Alert` if you want to inform the user about a specific action they need to do after something happened.
|
44
|
-
|
45
|
-
* ### How to NOT use it?
|
46
|
-
* Do not use the component to give higher visibility to trivial information, use the [Insert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-insert--basic) component instead.
|
47
|
-
* Make sure that alerts are not stacking, We highly recommend to have only one per page if possible, though we understand that sometimes this is not possible.
|
48
|
-
* Do not use a product wide `Alert` to display features information.
|
49
|
-
|
50
|
-
* ### Variants
|
51
|
-
* This component comes with two sets of Variants:
|
52
|
-
|
53
|
-
* #### Color
|
54
|
-
* - `Grey` `Default`
|
55
|
-
* Use this as your default Alert if no other color matches your use-case.
|
56
|
-
* - `Accent` `Primary`
|
57
|
-
* Use this to represent something that is currently happening with no level of severity.
|
58
|
-
* - `Green` `Success`
|
59
|
-
* Use this to inform the user that an action has been completed in the background while the user wasn't on that page and/or needs further exploration from the user. For smaller and quick processes use the [Flag](https://algolia-satellite.netlify.app/?path=/docs/indicators-flag--basic) instead.
|
60
|
-
* - `Orange` `Warning`
|
61
|
-
* Use this to show the user that something important requires their attention. The warning should be used for low to medium errors.
|
62
|
-
* - `Red` `Failure`
|
63
|
-
* Use this to show the user that something requires their full attention and actions. Only use red for critical warnings that will result in a loss of data of production down time.
|
64
|
-
|
65
|
-
* #### Usage Context
|
66
|
-
* - `Page`
|
67
|
-
* This is for global and product wide alerts, use that with extreme caution as it's will impact every page and every feature.
|
68
|
-
* - `Section`
|
69
|
-
* This alert should be inside the frame of a section and linked to the content it impacts
|
70
|
-
|
71
|
-
* ### Do's and Don't
|
72
|
-
* TODO
|
73
|
-
|
74
|
-
* ## Accessibility
|
75
|
-
* TODO
|
28
|
+
* The `Alert` component give users suggestions, tips, warnings, and error information without stopping them from completing the tasks they're doing.
|
29
|
+
*
|
30
|
+
* See the [Alert documentation page](https://satellite.algolia.com/components/feedback/alert) for more information.
|
76
31
|
*/
|
77
32
|
export declare const Alert: VFC<AlertProps>;
|
78
33
|
export default Alert;
|
@@ -37,54 +37,9 @@ var ICON_CLASSNAME_VARIANTS = {
|
|
37
37
|
};
|
38
38
|
|
39
39
|
/**
|
40
|
-
*
|
41
|
-
|
42
|
-
*
|
43
|
-
* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A262266)
|
44
|
-
|
45
|
-
* ## Current Status
|
46
|
-
* - [x] Figma
|
47
|
-
* - [x] React
|
48
|
-
* - [ ] Documentation
|
49
|
-
|
50
|
-
* ## Component structure
|
51
|
-
* This component uses a common banner structure. It uses an icon that should match the intent of the message, an optional title _(Highly recommended)_, a short paragraph of text and optional buttons for follow up actions. The `Alert` is dismissible by default, to do so a cross icon is displayed on the top-right corner.
|
52
|
-
|
53
|
-
* ## Guidelines
|
54
|
-
* ### How to use it?
|
55
|
-
* Use the `Alert` if you want to inform the user about a specific action they need to do after something happened.
|
56
|
-
|
57
|
-
* ### How to NOT use it?
|
58
|
-
* Do not use the component to give higher visibility to trivial information, use the [Insert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-insert--basic) component instead.
|
59
|
-
* Make sure that alerts are not stacking, We highly recommend to have only one per page if possible, though we understand that sometimes this is not possible.
|
60
|
-
* Do not use a product wide `Alert` to display features information.
|
61
|
-
|
62
|
-
* ### Variants
|
63
|
-
* This component comes with two sets of Variants:
|
64
|
-
|
65
|
-
* #### Color
|
66
|
-
* - `Grey` `Default`
|
67
|
-
* Use this as your default Alert if no other color matches your use-case.
|
68
|
-
* - `Accent` `Primary`
|
69
|
-
* Use this to represent something that is currently happening with no level of severity.
|
70
|
-
* - `Green` `Success`
|
71
|
-
* Use this to inform the user that an action has been completed in the background while the user wasn't on that page and/or needs further exploration from the user. For smaller and quick processes use the [Flag](https://algolia-satellite.netlify.app/?path=/docs/indicators-flag--basic) instead.
|
72
|
-
* - `Orange` `Warning`
|
73
|
-
* Use this to show the user that something important requires their attention. The warning should be used for low to medium errors.
|
74
|
-
* - `Red` `Failure`
|
75
|
-
* Use this to show the user that something requires their full attention and actions. Only use red for critical warnings that will result in a loss of data of production down time.
|
76
|
-
|
77
|
-
* #### Usage Context
|
78
|
-
* - `Page`
|
79
|
-
* This is for global and product wide alerts, use that with extreme caution as it's will impact every page and every feature.
|
80
|
-
* - `Section`
|
81
|
-
* This alert should be inside the frame of a section and linked to the content it impacts
|
82
|
-
|
83
|
-
* ### Do's and Don't
|
84
|
-
* TODO
|
85
|
-
|
86
|
-
* ## Accessibility
|
87
|
-
* TODO
|
40
|
+
* The `Alert` component give users suggestions, tips, warnings, and error information without stopping them from completing the tasks they're doing.
|
41
|
+
*
|
42
|
+
* See the [Alert documentation page](https://satellite.algolia.com/components/feedback/alert) for more information.
|
88
43
|
*/
|
89
44
|
export var Alert = function Alert(_ref) {
|
90
45
|
var title = _ref.title,
|
@@ -5,37 +5,9 @@ export interface BigBerthaProps {
|
|
5
5
|
children: ReactNode;
|
6
6
|
}
|
7
7
|
/**
|
8
|
-
*
|
9
|
-
|
10
|
-
*
|
11
|
-
* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279476)
|
12
|
-
|
13
|
-
* ## Current Status
|
14
|
-
* - [x] Figma
|
15
|
-
* - [x] React
|
16
|
-
* - [ ] Documentation
|
17
|
-
|
18
|
-
* ## Component structure
|
19
|
-
* This is a simple high contrast banner. It use an icon that should match the content of the message, a short text that describe the situation and can contain "Learn more" links.
|
20
|
-
|
21
|
-
* ## Guidelines
|
22
|
-
|
23
|
-
* ### How to use it?
|
24
|
-
* This component should only be used to inform the user about an on-going situation at Algolia that will impact the users' or end-users' experience with our products. The content of the message should be concise and explicit. Make sure that the tone used in the text does not generate stress.
|
25
|
-
|
26
|
-
* ### How to NOT use it?
|
27
|
-
* - Do not use this banner for any non critical announcement or any non product wide announcement.
|
28
|
-
* - If you want to inform the user about something in your features, please use the [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants) component.
|
29
|
-
* - If you want to promote a specific feature, please use the [Promote Banner](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-promote--basic) component.
|
30
|
-
|
31
|
-
* ### Variants
|
32
|
-
* - Blue banner : Default state of this component
|
33
|
-
|
34
|
-
* ### Do's and Don't
|
35
|
-
* TODO
|
36
|
-
|
37
|
-
* ## Accessibility
|
38
|
-
* TODO
|
8
|
+
* The `BigBertha` component is a top-of-page alert for critical system messages, updates, and urgent warnings.
|
9
|
+
*
|
10
|
+
* See the [Big Bertha documentation page](https://satellite.algolia.com/components/feedback/big-bertha) for more information.
|
39
11
|
*/
|
40
12
|
export declare const BigBertha: VFC<BigBerthaProps>;
|
41
13
|
export default BigBertha;
|
@@ -5,37 +5,9 @@ import stl from "../../styles/helpers/satellitePrefixer";
|
|
5
5
|
import { jsx as _jsx } from "react/jsx-runtime";
|
6
6
|
import { jsxs as _jsxs } from "react/jsx-runtime";
|
7
7
|
/**
|
8
|
-
*
|
9
|
-
|
10
|
-
*
|
11
|
-
* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279476)
|
12
|
-
|
13
|
-
* ## Current Status
|
14
|
-
* - [x] Figma
|
15
|
-
* - [x] React
|
16
|
-
* - [ ] Documentation
|
17
|
-
|
18
|
-
* ## Component structure
|
19
|
-
* This is a simple high contrast banner. It use an icon that should match the content of the message, a short text that describe the situation and can contain "Learn more" links.
|
20
|
-
|
21
|
-
* ## Guidelines
|
22
|
-
|
23
|
-
* ### How to use it?
|
24
|
-
* This component should only be used to inform the user about an on-going situation at Algolia that will impact the users' or end-users' experience with our products. The content of the message should be concise and explicit. Make sure that the tone used in the text does not generate stress.
|
25
|
-
|
26
|
-
* ### How to NOT use it?
|
27
|
-
* - Do not use this banner for any non critical announcement or any non product wide announcement.
|
28
|
-
* - If you want to inform the user about something in your features, please use the [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants) component.
|
29
|
-
* - If you want to promote a specific feature, please use the [Promote Banner](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-promote--basic) component.
|
30
|
-
|
31
|
-
* ### Variants
|
32
|
-
* - Blue banner : Default state of this component
|
33
|
-
|
34
|
-
* ### Do's and Don't
|
35
|
-
* TODO
|
36
|
-
|
37
|
-
* ## Accessibility
|
38
|
-
* TODO
|
8
|
+
* The `BigBertha` component is a top-of-page alert for critical system messages, updates, and urgent warnings.
|
9
|
+
*
|
10
|
+
* See the [Big Bertha documentation page](https://satellite.algolia.com/components/feedback/big-bertha) for more information.
|
39
11
|
*/
|
40
12
|
export var BigBertha = function BigBertha(_ref) {
|
41
13
|
var icon = _ref.icon,
|
@@ -20,32 +20,9 @@ export declare type PromoteProps = {
|
|
20
20
|
children: ReactNode;
|
21
21
|
} & (CompactPromoteProps | WidePromoteProps);
|
22
22
|
/**
|
23
|
-
*
|
24
|
-
|
25
|
-
*
|
26
|
-
* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279945)
|
27
|
-
|
28
|
-
* ## Current Status
|
29
|
-
* - [x] Figma
|
30
|
-
* - [x] React
|
31
|
-
* - [ ] Documentation
|
32
|
-
|
33
|
-
* ## Component structure
|
34
|
-
* This component is a bigger banner. It include an optional image, an optional product context, a title, a short text (2 lines maximum without an image and 3 lines maximum with an image), optional CTAs (one primary and one secondary). It comes in two different variants: `large` and `compact`.
|
35
|
-
|
36
|
-
* ## Guidelines
|
37
|
-
* ### How to use it?
|
38
|
-
* You should use this component to display to the users that a new features/product is now available for them in the current context they are in. This feature can be automatically available or locked behind higher plan tier, please make sure you adapt the content to not give false impression of availability to the user.
|
39
|
-
|
40
|
-
* This component is permanently dismissible by default.
|
41
|
-
|
42
|
-
* ### How to NOT use it?
|
43
|
-
* - Do not use this banner as a regular [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants).
|
44
|
-
* - You can only use one `large` promotion banner per context and two/four compact per context.
|
45
|
-
|
46
|
-
* ### Variants
|
47
|
-
* - `large`
|
48
|
-
* - `compact`
|
23
|
+
* The `Promote` component is a contextual way of showing a user that a new feature or product is available to them on a higher plan or as an option.
|
24
|
+
*
|
25
|
+
* See the [Promote documentation page](https://satellite.algolia.com/components/feedback/promote-banner) for more information.
|
49
26
|
*/
|
50
27
|
export declare const Promote: VFC<PromoteProps>;
|
51
28
|
export default Promote;
|
@@ -21,32 +21,9 @@ var ACTIONS_VARIANT_CLASSNAMES = {
|
|
21
21
|
};
|
22
22
|
|
23
23
|
/**
|
24
|
-
*
|
25
|
-
|
26
|
-
*
|
27
|
-
* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279945)
|
28
|
-
|
29
|
-
* ## Current Status
|
30
|
-
* - [x] Figma
|
31
|
-
* - [x] React
|
32
|
-
* - [ ] Documentation
|
33
|
-
|
34
|
-
* ## Component structure
|
35
|
-
* This component is a bigger banner. It include an optional image, an optional product context, a title, a short text (2 lines maximum without an image and 3 lines maximum with an image), optional CTAs (one primary and one secondary). It comes in two different variants: `large` and `compact`.
|
36
|
-
|
37
|
-
* ## Guidelines
|
38
|
-
* ### How to use it?
|
39
|
-
* You should use this component to display to the users that a new features/product is now available for them in the current context they are in. This feature can be automatically available or locked behind higher plan tier, please make sure you adapt the content to not give false impression of availability to the user.
|
40
|
-
|
41
|
-
* This component is permanently dismissible by default.
|
42
|
-
|
43
|
-
* ### How to NOT use it?
|
44
|
-
* - Do not use this banner as a regular [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants).
|
45
|
-
* - You can only use one `large` promotion banner per context and two/four compact per context.
|
46
|
-
|
47
|
-
* ### Variants
|
48
|
-
* - `large`
|
49
|
-
* - `compact`
|
24
|
+
* The `Promote` component is a contextual way of showing a user that a new feature or product is available to them on a higher plan or as an option.
|
25
|
+
*
|
26
|
+
* See the [Promote documentation page](https://satellite.algolia.com/components/feedback/promote-banner) for more information.
|
50
27
|
*/
|
51
28
|
export var Promote = function Promote(_ref) {
|
52
29
|
var context = _ref.context,
|
package/esm/Button/Button.d.ts
CHANGED
@@ -2,18 +2,9 @@
|
|
2
2
|
import { type PolymorphicButtonProps } from "./PolymorphicButton";
|
3
3
|
export declare type ButtonProps = Omit<PolymorphicButtonProps<"button">, "as" | "ref">;
|
4
4
|
/**
|
5
|
-
*
|
5
|
+
* The `Button` component is used to trigger user actions (like "Add", "Close" or "Save") or navigate users elsewhere through the links. It can contain a combination of a clear label and an icon while links are always text.
|
6
6
|
*
|
7
|
-
*
|
8
|
-
* - **Primary**: to highlight the strongest action on a page. Should only appear once per screen. Not every screen requires a primary button
|
9
|
-
* - **Neutral (default)**: the standard button for most use cases
|
10
|
-
* - **Destructive**: appears as a final confirmation for a destructive action (e.g. deleting an index). Should be used with care, primarily in confirmation modals
|
11
|
-
* - **Subtle-neutral**: user with a primary button or for actionals that are less crucial (e.g. Cancel)
|
12
|
-
*
|
13
|
-
* ## Styles
|
14
|
-
* - Use icons before the label in any button type to draw more attention to it, or help convey more meaning
|
15
|
-
* - Use icon-only button for an action that is less critical and doesn't have to drag too much of user attention
|
16
|
-
* - Buttons can take the full width to fill the parent container
|
7
|
+
* See the [Button documentation page](https://satellite.algolia.com/components/actions/button) for more information.
|
17
8
|
*/
|
18
9
|
export declare const Button: import("react").ForwardRefExoticComponent<ButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
|
19
10
|
export default Button;
|
package/esm/Button/Button.js
CHANGED
@@ -5,18 +5,9 @@ import { forwardRef } from "react";
|
|
5
5
|
import { PolymorphicButton } from "./PolymorphicButton";
|
6
6
|
import { jsx as _jsx } from "react/jsx-runtime";
|
7
7
|
/**
|
8
|
-
*
|
8
|
+
* The `Button` component is used to trigger user actions (like "Add", "Close" or "Save") or navigate users elsewhere through the links. It can contain a combination of a clear label and an icon while links are always text.
|
9
9
|
*
|
10
|
-
*
|
11
|
-
* - **Primary**: to highlight the strongest action on a page. Should only appear once per screen. Not every screen requires a primary button
|
12
|
-
* - **Neutral (default)**: the standard button for most use cases
|
13
|
-
* - **Destructive**: appears as a final confirmation for a destructive action (e.g. deleting an index). Should be used with care, primarily in confirmation modals
|
14
|
-
* - **Subtle-neutral**: user with a primary button or for actionals that are less crucial (e.g. Cancel)
|
15
|
-
*
|
16
|
-
* ## Styles
|
17
|
-
* - Use icons before the label in any button type to draw more attention to it, or help convey more meaning
|
18
|
-
* - Use icon-only button for an action that is less critical and doesn't have to drag too much of user attention
|
19
|
-
* - Buttons can take the full width to fill the parent container
|
10
|
+
* See the [Button documentation page](https://satellite.algolia.com/components/actions/button) for more information.
|
20
11
|
*/
|
21
12
|
export var Button = /*#__PURE__*/forwardRef(function (props, ref) {
|
22
13
|
return /*#__PURE__*/_jsx(PolymorphicButton, _objectSpread(_objectSpread({}, props), {}, {
|