@primer/components 0.0.0-202198182351 → 0.0.0-20219819465
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/CHANGELOG.md +1 -1
- package/dist/browser.esm.js +295 -294
- package/dist/browser.esm.js.map +1 -1
- package/dist/browser.umd.js +369 -368
- package/dist/browser.umd.js.map +1 -1
- package/lib/AnchoredOverlay/AnchoredOverlay.d.ts +2 -1
- package/lib/AnchoredOverlay/AnchoredOverlay.js +11 -3
- package/lib/Autocomplete/Autocomplete.d.ts +40 -0
- package/lib/Autocomplete/Autocomplete.js +68 -0
- package/lib/Autocomplete/AutocompleteContext.d.ts +17 -0
- package/lib/Autocomplete/AutocompleteContext.js +11 -0
- package/lib/Autocomplete/AutocompleteInput.d.ts +9 -0
- package/lib/Autocomplete/AutocompleteInput.js +150 -0
- package/lib/Autocomplete/AutocompleteMenu.d.ts +71 -0
- package/lib/Autocomplete/AutocompleteMenu.js +223 -0
- package/lib/Autocomplete/AutocompleteOverlay.d.ts +17 -0
- package/lib/Autocomplete/AutocompleteOverlay.js +74 -0
- package/lib/Autocomplete/index.d.ts +2 -0
- package/lib/Autocomplete/index.js +15 -0
- package/lib/FilteredActionList/FilteredActionList.js +5 -31
- package/lib/Overlay.d.ts +2 -1
- package/lib/Overlay.js +10 -5
- package/lib/TextInput.d.ts +4 -12
- package/lib/TextInput.js +4 -46
- package/lib/TextInputWithTokens.d.ts +323 -0
- package/lib/TextInputWithTokens.js +244 -0
- package/lib/_TextInputWrapper.d.ts +10 -0
- package/lib/_TextInputWrapper.js +51 -0
- package/lib/_UnstyledTextInput.d.ts +2 -0
- package/lib/_UnstyledTextInput.js +20 -0
- package/lib/hooks/useOpenAndCloseFocus.d.ts +2 -1
- package/lib/hooks/useOpenAndCloseFocus.js +7 -2
- package/lib/hooks/useOverlay.d.ts +2 -1
- package/lib/hooks/useOverlay.js +4 -2
- package/lib/index.d.ts +3 -0
- package/lib/index.js +16 -0
- package/lib/utils/scrollIntoViewingArea.d.ts +1 -0
- package/lib/utils/scrollIntoViewingArea.js +39 -0
- package/lib/utils/types/MandateProps.d.ts +3 -0
- package/lib/utils/types/MandateProps.js +1 -0
- package/lib/utils/types/index.d.ts +1 -0
- package/lib/utils/types/index.js +13 -0
- package/lib-esm/AnchoredOverlay/AnchoredOverlay.d.ts +2 -1
- package/lib-esm/AnchoredOverlay/AnchoredOverlay.js +11 -3
- package/lib-esm/Autocomplete/Autocomplete.d.ts +40 -0
- package/lib-esm/Autocomplete/Autocomplete.js +47 -0
- package/lib-esm/Autocomplete/AutocompleteContext.d.ts +17 -0
- package/lib-esm/Autocomplete/AutocompleteContext.js +2 -0
- package/lib-esm/Autocomplete/AutocompleteInput.d.ts +9 -0
- package/lib-esm/Autocomplete/AutocompleteInput.js +131 -0
- package/lib-esm/Autocomplete/AutocompleteMenu.d.ts +71 -0
- package/lib-esm/Autocomplete/AutocompleteMenu.js +204 -0
- package/lib-esm/Autocomplete/AutocompleteOverlay.d.ts +17 -0
- package/lib-esm/Autocomplete/AutocompleteOverlay.js +56 -0
- package/lib-esm/Autocomplete/index.d.ts +2 -0
- package/lib-esm/Autocomplete/index.js +1 -0
- package/lib-esm/FilteredActionList/FilteredActionList.js +3 -31
- package/lib-esm/Overlay.d.ts +2 -1
- package/lib-esm/Overlay.js +8 -5
- package/lib-esm/TextInput.d.ts +4 -12
- package/lib-esm/TextInput.js +4 -37
- package/lib-esm/TextInputWithTokens.d.ts +323 -0
- package/lib-esm/TextInputWithTokens.js +219 -0
- package/lib-esm/_TextInputWrapper.d.ts +10 -0
- package/lib-esm/_TextInputWrapper.js +31 -0
- package/lib-esm/_UnstyledTextInput.d.ts +2 -0
- package/lib-esm/_UnstyledTextInput.js +7 -0
- package/lib-esm/hooks/useOpenAndCloseFocus.d.ts +2 -1
- package/lib-esm/hooks/useOpenAndCloseFocus.js +7 -2
- package/lib-esm/hooks/useOverlay.d.ts +2 -1
- package/lib-esm/hooks/useOverlay.js +4 -2
- package/lib-esm/index.d.ts +3 -0
- package/lib-esm/index.js +2 -0
- package/lib-esm/utils/scrollIntoViewingArea.d.ts +1 -0
- package/lib-esm/utils/scrollIntoViewingArea.js +30 -0
- package/lib-esm/utils/types/MandateProps.d.ts +3 -0
- package/lib-esm/utils/types/MandateProps.js +1 -0
- package/lib-esm/utils/types/index.d.ts +1 -0
- package/lib-esm/utils/types/index.js +2 -1
- package/package.json +1 -1
@@ -3,5 +3,6 @@ export declare type UseOpenAndCloseFocusSettings = {
|
|
3
3
|
initialFocusRef?: React.RefObject<HTMLElement>;
|
4
4
|
containerRef: React.RefObject<HTMLElement>;
|
5
5
|
returnFocusRef: React.RefObject<HTMLElement>;
|
6
|
+
preventFocusOnOpen?: boolean;
|
6
7
|
};
|
7
|
-
export declare function useOpenAndCloseFocus({ initialFocusRef, returnFocusRef, containerRef }: UseOpenAndCloseFocusSettings): void;
|
8
|
+
export declare function useOpenAndCloseFocus({ initialFocusRef, returnFocusRef, containerRef, preventFocusOnOpen }: UseOpenAndCloseFocusSettings): void;
|
@@ -12,9 +12,14 @@ var _iterateFocusableElements = require("../utils/iterateFocusableElements");
|
|
12
12
|
function useOpenAndCloseFocus({
|
13
13
|
initialFocusRef,
|
14
14
|
returnFocusRef,
|
15
|
-
containerRef
|
15
|
+
containerRef,
|
16
|
+
preventFocusOnOpen
|
16
17
|
}) {
|
17
18
|
(0, _react.useEffect)(() => {
|
19
|
+
if (preventFocusOnOpen) {
|
20
|
+
return;
|
21
|
+
}
|
22
|
+
|
18
23
|
const returnRef = returnFocusRef.current;
|
19
24
|
|
20
25
|
if (initialFocusRef && initialFocusRef.current) {
|
@@ -27,5 +32,5 @@ function useOpenAndCloseFocus({
|
|
27
32
|
return function () {
|
28
33
|
returnRef === null || returnRef === void 0 ? void 0 : returnRef.focus();
|
29
34
|
};
|
30
|
-
}, [initialFocusRef, returnFocusRef, containerRef]);
|
35
|
+
}, [initialFocusRef, returnFocusRef, containerRef, preventFocusOnOpen]);
|
31
36
|
}
|
@@ -7,8 +7,9 @@ export declare type UseOverlaySettings = {
|
|
7
7
|
onEscape: (e: KeyboardEvent) => void;
|
8
8
|
onClickOutside: (e: TouchOrMouseEvent) => void;
|
9
9
|
overlayRef?: React.RefObject<HTMLDivElement>;
|
10
|
+
preventFocusOnOpen?: boolean;
|
10
11
|
};
|
11
12
|
export declare type OverlayReturnProps = {
|
12
13
|
ref: React.RefObject<HTMLDivElement>;
|
13
14
|
};
|
14
|
-
export declare const useOverlay: ({ overlayRef: _overlayRef, returnFocusRef, initialFocusRef, onEscape, ignoreClickRefs, onClickOutside }: UseOverlaySettings) => OverlayReturnProps;
|
15
|
+
export declare const useOverlay: ({ overlayRef: _overlayRef, returnFocusRef, initialFocusRef, onEscape, ignoreClickRefs, onClickOutside, preventFocusOnOpen }: UseOverlaySettings) => OverlayReturnProps;
|
package/lib/hooks/useOverlay.js
CHANGED
@@ -19,13 +19,15 @@ const useOverlay = ({
|
|
19
19
|
initialFocusRef,
|
20
20
|
onEscape,
|
21
21
|
ignoreClickRefs,
|
22
|
-
onClickOutside
|
22
|
+
onClickOutside,
|
23
|
+
preventFocusOnOpen
|
23
24
|
}) => {
|
24
25
|
const overlayRef = (0, _useProvidedRefOrCreate.useProvidedRefOrCreate)(_overlayRef);
|
25
26
|
(0, _useOpenAndCloseFocus.useOpenAndCloseFocus)({
|
26
27
|
containerRef: overlayRef,
|
27
28
|
returnFocusRef,
|
28
|
-
initialFocusRef
|
29
|
+
initialFocusRef,
|
30
|
+
preventFocusOnOpen
|
29
31
|
});
|
30
32
|
(0, _useOnOutsideClick.useOnOutsideClick)({
|
31
33
|
containerRef: overlayRef,
|
package/lib/index.d.ts
CHANGED
@@ -24,6 +24,7 @@ export { useConfirm } from './Dialog/ConfirmationDialog';
|
|
24
24
|
export { ActionList } from './ActionList';
|
25
25
|
export { ActionMenu } from './ActionMenu';
|
26
26
|
export type { ActionMenuProps } from './ActionMenu';
|
27
|
+
export { default as Autocomplete } from './Autocomplete';
|
27
28
|
export { default as Avatar } from './Avatar';
|
28
29
|
export type { AvatarProps } from './Avatar';
|
29
30
|
export { default as AvatarPair } from './AvatarPair';
|
@@ -98,6 +99,8 @@ export { default as TabNav } from './TabNav';
|
|
98
99
|
export type { TabNavProps, TabNavLinkProps } from './TabNav';
|
99
100
|
export { default as TextInput } from './TextInput';
|
100
101
|
export type { TextInputProps } from './TextInput';
|
102
|
+
export { default as TextInputWithTokens } from './TextInputWithTokens';
|
103
|
+
export type { TextInputWithTokensProps } from './TextInputWithTokens';
|
101
104
|
export { default as Text } from './Text';
|
102
105
|
export type { TextProps } from './Text';
|
103
106
|
export { default as Timeline } from './Timeline';
|
package/lib/index.js
CHANGED
@@ -153,6 +153,12 @@ Object.defineProperty(exports, "ActionMenu", {
|
|
153
153
|
return _ActionMenu.ActionMenu;
|
154
154
|
}
|
155
155
|
});
|
156
|
+
Object.defineProperty(exports, "Autocomplete", {
|
157
|
+
enumerable: true,
|
158
|
+
get: function () {
|
159
|
+
return _Autocomplete.default;
|
160
|
+
}
|
161
|
+
});
|
156
162
|
Object.defineProperty(exports, "Avatar", {
|
157
163
|
enumerable: true,
|
158
164
|
get: function () {
|
@@ -429,6 +435,12 @@ Object.defineProperty(exports, "TextInput", {
|
|
429
435
|
return _TextInput.default;
|
430
436
|
}
|
431
437
|
});
|
438
|
+
Object.defineProperty(exports, "TextInputWithTokens", {
|
439
|
+
enumerable: true,
|
440
|
+
get: function () {
|
441
|
+
return _TextInputWithTokens.default;
|
442
|
+
}
|
443
|
+
});
|
432
444
|
Object.defineProperty(exports, "Text", {
|
433
445
|
enumerable: true,
|
434
446
|
get: function () {
|
@@ -526,6 +538,8 @@ var _ActionList = require("./ActionList");
|
|
526
538
|
|
527
539
|
var _ActionMenu = require("./ActionMenu");
|
528
540
|
|
541
|
+
var _Autocomplete = _interopRequireDefault(require("./Autocomplete"));
|
542
|
+
|
529
543
|
var _Avatar = _interopRequireDefault(require("./Avatar"));
|
530
544
|
|
531
545
|
var _AvatarPair = _interopRequireDefault(require("./AvatarPair"));
|
@@ -600,6 +614,8 @@ var _TabNav = _interopRequireDefault(require("./TabNav"));
|
|
600
614
|
|
601
615
|
var _TextInput = _interopRequireDefault(require("./TextInput"));
|
602
616
|
|
617
|
+
var _TextInputWithTokens = _interopRequireDefault(require("./TextInputWithTokens"));
|
618
|
+
|
603
619
|
var _Text = _interopRequireDefault(require("./Text"));
|
604
620
|
|
605
621
|
var _Timeline = _interopRequireDefault(require("./Timeline"));
|
@@ -0,0 +1 @@
|
|
1
|
+
export declare const scrollIntoViewingArea: (child: HTMLElement, container: HTMLElement, direction?: 'horizontal' | 'vertical', startMargin?: number, endMargin?: number, behavior?: ScrollBehavior) => void;
|
@@ -0,0 +1,39 @@
|
|
1
|
+
"use strict";
|
2
|
+
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
4
|
+
value: true
|
5
|
+
});
|
6
|
+
exports.scrollIntoViewingArea = void 0;
|
7
|
+
|
8
|
+
const scrollIntoViewingArea = (child, container, direction = 'vertical', startMargin = 8, endMargin = 0, behavior = 'smooth') => {
|
9
|
+
const startSide = direction === 'vertical' ? 'top' : 'left';
|
10
|
+
const endSide = direction === 'vertical' ? 'bottom' : 'right';
|
11
|
+
const scrollSide = direction === 'vertical' ? 'scrollTop' : 'scrollLeft';
|
12
|
+
const {
|
13
|
+
[startSide]: childStart,
|
14
|
+
[endSide]: childEnd
|
15
|
+
} = child.getBoundingClientRect();
|
16
|
+
const {
|
17
|
+
[startSide]: containerStart,
|
18
|
+
[endSide]: containerEnd
|
19
|
+
} = container.getBoundingClientRect();
|
20
|
+
const isChildStartAboveViewingArea = childStart < containerStart + endMargin;
|
21
|
+
const isChildBottomBelowViewingArea = childEnd > containerEnd - startMargin;
|
22
|
+
|
23
|
+
if (isChildStartAboveViewingArea) {
|
24
|
+
const scrollHeightToChildStart = childStart - containerStart + container[scrollSide];
|
25
|
+
container.scrollTo({
|
26
|
+
behavior,
|
27
|
+
[startSide]: scrollHeightToChildStart - endMargin
|
28
|
+
});
|
29
|
+
} else if (isChildBottomBelowViewingArea) {
|
30
|
+
const scrollHeightToChildBottom = childEnd - containerEnd + container[scrollSide];
|
31
|
+
container.scrollTo({
|
32
|
+
behavior,
|
33
|
+
[startSide]: scrollHeightToChildBottom + startMargin
|
34
|
+
});
|
35
|
+
} // either completely in view or outside viewing area on both ends, don't scroll
|
36
|
+
|
37
|
+
};
|
38
|
+
|
39
|
+
exports.scrollIntoViewingArea = scrollIntoViewingArea;
|
@@ -0,0 +1 @@
|
|
1
|
+
"use strict";
|
package/lib/utils/types/index.js
CHANGED
@@ -54,4 +54,17 @@ Object.keys(_Merge).forEach(function (key) {
|
|
54
54
|
return _Merge[key];
|
55
55
|
}
|
56
56
|
});
|
57
|
+
});
|
58
|
+
|
59
|
+
var _MandateProps = require("./MandateProps");
|
60
|
+
|
61
|
+
Object.keys(_MandateProps).forEach(function (key) {
|
62
|
+
if (key === "default" || key === "__esModule") return;
|
63
|
+
if (key in exports && exports[key] === _MandateProps[key]) return;
|
64
|
+
Object.defineProperty(exports, key, {
|
65
|
+
enumerable: true,
|
66
|
+
get: function () {
|
67
|
+
return _MandateProps[key];
|
68
|
+
}
|
69
|
+
});
|
57
70
|
});
|
@@ -2,6 +2,7 @@ import React from 'react';
|
|
2
2
|
import { OverlayProps } from '../Overlay';
|
3
3
|
import { FocusTrapHookSettings } from '../hooks/useFocusTrap';
|
4
4
|
import { FocusZoneHookSettings } from '../hooks/useFocusZone';
|
5
|
+
import { PositionSettings } from '../behaviors/anchoredPosition';
|
5
6
|
interface AnchoredOverlayPropsWithAnchor {
|
6
7
|
/**
|
7
8
|
* A custom function component used to render the anchor element.
|
@@ -52,7 +53,7 @@ interface AnchoredOverlayBaseProps extends Pick<OverlayProps, 'height' | 'width'
|
|
52
53
|
*/
|
53
54
|
focusZoneSettings?: Partial<FocusZoneHookSettings>;
|
54
55
|
}
|
55
|
-
export declare type AnchoredOverlayProps = AnchoredOverlayBaseProps & (AnchoredOverlayPropsWithAnchor | AnchoredOverlayPropsWithoutAnchor)
|
56
|
+
export declare type AnchoredOverlayProps = AnchoredOverlayBaseProps & (AnchoredOverlayPropsWithAnchor | AnchoredOverlayPropsWithoutAnchor) & Partial<Pick<PositionSettings, 'align' | 'side'>>;
|
56
57
|
/**
|
57
58
|
* An `AnchoredOverlay` provides an anchor that will open a floating overlay positioned relative to the anchor.
|
58
59
|
* The overlay can be opened and navigated using keyboard or mouse.
|
@@ -22,7 +22,9 @@ export const AnchoredOverlay = ({
|
|
22
22
|
width,
|
23
23
|
overlayProps,
|
24
24
|
focusTrapSettings,
|
25
|
-
focusZoneSettings
|
25
|
+
focusZoneSettings,
|
26
|
+
side,
|
27
|
+
align
|
26
28
|
}) => {
|
27
29
|
const anchorRef = useProvidedRefOrCreate(externalAnchorRef);
|
28
30
|
const [overlayRef, updateOverlayRef] = useRenderForcingRef();
|
@@ -52,7 +54,9 @@ export const AnchoredOverlay = ({
|
|
52
54
|
position
|
53
55
|
} = useAnchoredPosition({
|
54
56
|
anchorElementRef: anchorRef,
|
55
|
-
floatingElementRef: overlayRef
|
57
|
+
floatingElementRef: overlayRef,
|
58
|
+
side,
|
59
|
+
align
|
56
60
|
}, [overlayRef.current]);
|
57
61
|
useEffect(() => {
|
58
62
|
// ensure overlay ref gets cleared when closed, so position can reset between closing/re-opening
|
@@ -93,4 +97,8 @@ export const AnchoredOverlay = ({
|
|
93
97
|
anchorSide: position === null || position === void 0 ? void 0 : position.anchorSide
|
94
98
|
}, overlayProps), children) : null);
|
95
99
|
};
|
96
|
-
AnchoredOverlay.displayName = 'AnchoredOverlay';
|
100
|
+
AnchoredOverlay.displayName = 'AnchoredOverlay';
|
101
|
+
AnchoredOverlay.defaultProps = {
|
102
|
+
side: 'outside-bottom',
|
103
|
+
align: 'start'
|
104
|
+
};
|
@@ -0,0 +1,40 @@
|
|
1
|
+
import React from 'react';
|
2
|
+
import { ComponentProps } from '../utils/types';
|
3
|
+
import AutocompleteMenu from './AutocompleteMenu';
|
4
|
+
declare const Autocomplete: React.FC<{
|
5
|
+
id?: string;
|
6
|
+
}>;
|
7
|
+
export declare type AutocompleteProps = ComponentProps<typeof Autocomplete>;
|
8
|
+
export type { AutocompleteInputProps } from './AutocompleteInput';
|
9
|
+
export type { AutocompleteMenuProps } from './AutocompleteMenu';
|
10
|
+
export type { AutocompleteOverlayProps } from './AutocompleteOverlay';
|
11
|
+
declare const _default: React.FC<{
|
12
|
+
id?: string | undefined;
|
13
|
+
}> & {
|
14
|
+
AutocompleteContext: React.Context<{
|
15
|
+
activeDescendantRef?: React.MutableRefObject<HTMLElement | null> | undefined;
|
16
|
+
autocompleteSuggestion?: string | undefined;
|
17
|
+
id?: string | undefined;
|
18
|
+
inputRef?: React.MutableRefObject<HTMLInputElement | null> | undefined;
|
19
|
+
inputValue?: string | undefined;
|
20
|
+
isMenuDirectlyActivated?: boolean | undefined;
|
21
|
+
scrollContainerRef?: React.MutableRefObject<HTMLElement | null> | undefined;
|
22
|
+
selectedItemLength?: number | undefined;
|
23
|
+
setAutocompleteSuggestion?: React.Dispatch<React.SetStateAction<string>> | undefined;
|
24
|
+
setInputValue?: React.Dispatch<React.SetStateAction<string>> | undefined;
|
25
|
+
setIsMenuDirectlyActivated?: React.Dispatch<React.SetStateAction<boolean>> | undefined;
|
26
|
+
setSelectedItemLength?: React.Dispatch<React.SetStateAction<number | undefined>> | undefined;
|
27
|
+
setShowMenu?: React.Dispatch<React.SetStateAction<boolean>> | undefined;
|
28
|
+
showMenu?: boolean | undefined;
|
29
|
+
}>;
|
30
|
+
Input: import("@radix-ui/react-polymorphic").ForwardRefComponent<"input", {
|
31
|
+
as?: React.ComponentType<any> | undefined;
|
32
|
+
}>;
|
33
|
+
Menu: typeof AutocompleteMenu;
|
34
|
+
Overlay: React.FC<{
|
35
|
+
menuAnchorRef?: React.RefObject<HTMLElement> | undefined;
|
36
|
+
overlayProps?: Partial<import("..").OverlayProps> | undefined;
|
37
|
+
children?: React.ReactNode;
|
38
|
+
} & Pick<React.AriaAttributes, "aria-labelledby">>;
|
39
|
+
};
|
40
|
+
export default _default;
|
@@ -0,0 +1,47 @@
|
|
1
|
+
import React, { useRef, useState } from 'react';
|
2
|
+
import { uniqueId } from '../utils/uniqueId';
|
3
|
+
import { AutocompleteContext } from './AutocompleteContext';
|
4
|
+
import AutocompleteInput from './AutocompleteInput';
|
5
|
+
import AutocompleteMenu from './AutocompleteMenu';
|
6
|
+
import AutocompleteOverlay from './AutocompleteOverlay';
|
7
|
+
|
8
|
+
const Autocomplete = ({
|
9
|
+
children,
|
10
|
+
id: idProp
|
11
|
+
}) => {
|
12
|
+
const activeDescendantRef = useRef(null);
|
13
|
+
const scrollContainerRef = useRef(null);
|
14
|
+
const inputRef = useRef(null);
|
15
|
+
const [inputValue, setInputValue] = useState('');
|
16
|
+
const [showMenu, setShowMenu] = useState(false);
|
17
|
+
const [autocompleteSuggestion, setAutocompleteSuggestion] = useState('');
|
18
|
+
const [isMenuDirectlyActivated, setIsMenuDirectlyActivated] = useState(false);
|
19
|
+
const [selectedItemLength, setSelectedItemLength] = useState();
|
20
|
+
const id = idProp || uniqueId();
|
21
|
+
return /*#__PURE__*/React.createElement(AutocompleteContext.Provider, {
|
22
|
+
value: {
|
23
|
+
activeDescendantRef,
|
24
|
+
autocompleteSuggestion,
|
25
|
+
id,
|
26
|
+
inputRef,
|
27
|
+
inputValue,
|
28
|
+
isMenuDirectlyActivated,
|
29
|
+
scrollContainerRef,
|
30
|
+
selectedItemLength,
|
31
|
+
setAutocompleteSuggestion,
|
32
|
+
setInputValue,
|
33
|
+
setIsMenuDirectlyActivated,
|
34
|
+
setShowMenu,
|
35
|
+
setSelectedItemLength,
|
36
|
+
showMenu
|
37
|
+
}
|
38
|
+
}, children);
|
39
|
+
};
|
40
|
+
|
41
|
+
Autocomplete.displayName = "Autocomplete";
|
42
|
+
export default Object.assign(Autocomplete, {
|
43
|
+
AutocompleteContext,
|
44
|
+
Input: AutocompleteInput,
|
45
|
+
Menu: AutocompleteMenu,
|
46
|
+
Overlay: AutocompleteOverlay
|
47
|
+
});
|
@@ -0,0 +1,17 @@
|
|
1
|
+
/// <reference types="react" />
|
2
|
+
export declare const AutocompleteContext: import("react").Context<{
|
3
|
+
activeDescendantRef?: import("react").MutableRefObject<HTMLElement | null> | undefined;
|
4
|
+
autocompleteSuggestion?: string | undefined;
|
5
|
+
id?: string | undefined;
|
6
|
+
inputRef?: import("react").MutableRefObject<HTMLInputElement | null> | undefined;
|
7
|
+
inputValue?: string | undefined;
|
8
|
+
isMenuDirectlyActivated?: boolean | undefined;
|
9
|
+
scrollContainerRef?: import("react").MutableRefObject<HTMLElement | null> | undefined;
|
10
|
+
selectedItemLength?: number | undefined;
|
11
|
+
setAutocompleteSuggestion?: import("react").Dispatch<import("react").SetStateAction<string>> | undefined;
|
12
|
+
setInputValue?: import("react").Dispatch<import("react").SetStateAction<string>> | undefined;
|
13
|
+
setIsMenuDirectlyActivated?: import("react").Dispatch<import("react").SetStateAction<boolean>> | undefined;
|
14
|
+
setSelectedItemLength?: import("react").Dispatch<import("react").SetStateAction<number | undefined>> | undefined;
|
15
|
+
setShowMenu?: import("react").Dispatch<import("react").SetStateAction<boolean>> | undefined;
|
16
|
+
showMenu?: boolean | undefined;
|
17
|
+
}>;
|
@@ -0,0 +1,9 @@
|
|
1
|
+
import React from 'react';
|
2
|
+
import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
|
3
|
+
import { ComponentProps } from '../utils/types';
|
4
|
+
declare type InternalAutocompleteInputProps = {
|
5
|
+
as?: React.ComponentType<any>;
|
6
|
+
};
|
7
|
+
declare const AutocompleteInput: PolymorphicForwardRefComponent<"input", InternalAutocompleteInputProps>;
|
8
|
+
export declare type AutocompleteInputProps = ComponentProps<typeof AutocompleteInput>;
|
9
|
+
export default AutocompleteInput;
|
@@ -0,0 +1,131 @@
|
|
1
|
+
function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
|
2
|
+
|
3
|
+
import React, { useCallback, useContext, useEffect, useState } from 'react';
|
4
|
+
import { AutocompleteContext } from './AutocompleteContext';
|
5
|
+
import TextInput from '../TextInput';
|
6
|
+
import { useCombinedRefs } from '../hooks/useCombinedRefs';
|
7
|
+
const AutocompleteInput = /*#__PURE__*/React.forwardRef(({
|
8
|
+
as: Component = TextInput,
|
9
|
+
onFocus,
|
10
|
+
onBlur,
|
11
|
+
onChange,
|
12
|
+
onKeyDown,
|
13
|
+
onKeyUp,
|
14
|
+
onKeyPress,
|
15
|
+
value,
|
16
|
+
...props
|
17
|
+
}, forwardedRef) => {
|
18
|
+
const {
|
19
|
+
activeDescendantRef,
|
20
|
+
autocompleteSuggestion = '',
|
21
|
+
id,
|
22
|
+
inputRef,
|
23
|
+
inputValue = '',
|
24
|
+
isMenuDirectlyActivated,
|
25
|
+
setInputValue,
|
26
|
+
setShowMenu,
|
27
|
+
showMenu
|
28
|
+
} = useContext(AutocompleteContext);
|
29
|
+
const combinedInputRef = useCombinedRefs(inputRef, forwardedRef);
|
30
|
+
const [highlightRemainingText, setHighlightRemainingText] = useState(true);
|
31
|
+
const handleInputFocus = useCallback(event => {
|
32
|
+
onFocus && onFocus(event);
|
33
|
+
setShowMenu && setShowMenu(true);
|
34
|
+
}, [onFocus, setShowMenu]);
|
35
|
+
const handleInputBlur = useCallback(event => {
|
36
|
+
onBlur && onBlur(event); // HACK: wait a tick and check the focused element before hiding the autocomplete menu
|
37
|
+
// this prevents the menu from hiding when the user is clicking an option in the Autoselect.Menu,
|
38
|
+
// but still hides the menu when the user blurs the input by tabbing out or clicking somewhere else on the page
|
39
|
+
|
40
|
+
setTimeout(() => {
|
41
|
+
if (document.activeElement !== combinedInputRef.current) {
|
42
|
+
setShowMenu && setShowMenu(false);
|
43
|
+
}
|
44
|
+
}, 0);
|
45
|
+
}, [onBlur, setShowMenu, combinedInputRef]);
|
46
|
+
const handleInputChange = useCallback(event => {
|
47
|
+
onChange && onChange(event);
|
48
|
+
setInputValue && setInputValue(event.currentTarget.value);
|
49
|
+
|
50
|
+
if (!showMenu) {
|
51
|
+
setShowMenu && setShowMenu(true);
|
52
|
+
}
|
53
|
+
}, [onChange, setInputValue, setShowMenu, showMenu]);
|
54
|
+
const handleInputKeyDown = useCallback(event => {
|
55
|
+
var _inputRef$current;
|
56
|
+
|
57
|
+
onKeyDown && onKeyDown(event);
|
58
|
+
|
59
|
+
if (event.key === 'Backspace') {
|
60
|
+
setHighlightRemainingText(false);
|
61
|
+
}
|
62
|
+
|
63
|
+
if (event.key === 'Escape' && inputRef !== null && inputRef !== void 0 && (_inputRef$current = inputRef.current) !== null && _inputRef$current !== void 0 && _inputRef$current.value) {
|
64
|
+
setInputValue && setInputValue('');
|
65
|
+
inputRef.current.value = '';
|
66
|
+
}
|
67
|
+
}, [inputRef, setInputValue, setHighlightRemainingText, onKeyDown]);
|
68
|
+
const handleInputKeyUp = useCallback(event => {
|
69
|
+
onKeyUp && onKeyUp(event);
|
70
|
+
|
71
|
+
if (event.key === 'Backspace') {
|
72
|
+
setHighlightRemainingText(true);
|
73
|
+
}
|
74
|
+
}, [setHighlightRemainingText, onKeyUp]);
|
75
|
+
const onInputKeyPress = useCallback(event => {
|
76
|
+
onKeyPress && onKeyPress(event);
|
77
|
+
|
78
|
+
if (showMenu && activeDescendantRef && event.key === 'Enter' && activeDescendantRef.current) {
|
79
|
+
event.preventDefault();
|
80
|
+
event.nativeEvent.stopImmediatePropagation(); // Forward Enter key press to active descendant so that item gets activated
|
81
|
+
|
82
|
+
const activeDescendantEvent = new KeyboardEvent(event.type, event.nativeEvent);
|
83
|
+
activeDescendantRef.current.dispatchEvent(activeDescendantEvent);
|
84
|
+
}
|
85
|
+
}, [activeDescendantRef, showMenu, onKeyPress]);
|
86
|
+
useEffect(() => {
|
87
|
+
if (!(inputRef !== null && inputRef !== void 0 && inputRef.current)) {
|
88
|
+
return;
|
89
|
+
} // resets input value to being empty after a selection has been made
|
90
|
+
|
91
|
+
|
92
|
+
if (!autocompleteSuggestion) {
|
93
|
+
inputRef.current.value = inputValue;
|
94
|
+
} // TODO: fix bug where this function prevents `onChange` from being triggered if the highlighted item text
|
95
|
+
// is the same as what I'm typing
|
96
|
+
// e.g.: typing 'tw' highights 'two', but when I 'two', the text input change does not get triggered
|
97
|
+
|
98
|
+
|
99
|
+
if (highlightRemainingText && autocompleteSuggestion && (inputValue || isMenuDirectlyActivated)) {
|
100
|
+
inputRef.current.value = autocompleteSuggestion;
|
101
|
+
|
102
|
+
if (autocompleteSuggestion.toLowerCase().indexOf(inputValue.toLowerCase()) === 0) {
|
103
|
+
inputRef.current.setSelectionRange(inputValue.length, autocompleteSuggestion.length);
|
104
|
+
}
|
105
|
+
} // calling this useEffeect when `highlightRemainingText` changes breaks backspace functionality
|
106
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
107
|
+
|
108
|
+
}, [autocompleteSuggestion, inputValue, inputRef, isMenuDirectlyActivated]);
|
109
|
+
useEffect(() => {
|
110
|
+
if (value) {
|
111
|
+
setInputValue && setInputValue(value.toString());
|
112
|
+
}
|
113
|
+
}, [value, setInputValue]);
|
114
|
+
return /*#__PURE__*/React.createElement(Component, _extends({
|
115
|
+
onFocus: handleInputFocus,
|
116
|
+
onBlur: handleInputBlur,
|
117
|
+
onChange: handleInputChange,
|
118
|
+
onKeyDown: handleInputKeyDown,
|
119
|
+
onKeyPress: onInputKeyPress,
|
120
|
+
onKeyUp: handleInputKeyUp,
|
121
|
+
ref: combinedInputRef,
|
122
|
+
"aria-controls": `${id}-listbox`,
|
123
|
+
"aria-autocomplete": "both",
|
124
|
+
role: "combobox",
|
125
|
+
"aria-expanded": showMenu,
|
126
|
+
"aria-haspopup": "listbox",
|
127
|
+
"aria-owns": `${id}-listbox`,
|
128
|
+
autocomplete: "off"
|
129
|
+
}, props));
|
130
|
+
});
|
131
|
+
export default AutocompleteInput;
|
@@ -0,0 +1,71 @@
|
|
1
|
+
import React from 'react';
|
2
|
+
import { ItemProps } from '../ActionList';
|
3
|
+
import { ComponentProps, MandateProps } from '../utils/types';
|
4
|
+
declare type OnSelectedChange<T> = (item: T | T[]) => void;
|
5
|
+
declare type AutocompleteItemProps<T = Record<string, any>> = MandateProps<ItemProps, 'id'> & {
|
6
|
+
metadata?: T;
|
7
|
+
};
|
8
|
+
export declare type AutocompleteMenuInternalProps<T extends AutocompleteItemProps> = {
|
9
|
+
/**
|
10
|
+
* A menu item that is used to allow users make a selection that is not available in the array passed to the `items` prop.
|
11
|
+
* This menu item gets appended to the end of the list of options.
|
12
|
+
*/
|
13
|
+
addNewItem?: Omit<T, 'onAction' | 'leadingVisual' | 'id'> & {
|
14
|
+
handleAddItem: (item: Omit<T, 'onAction' | 'leadingVisual'>) => void;
|
15
|
+
};
|
16
|
+
/**
|
17
|
+
* The text that appears in the menu when there are no options in the array passed to the `items` prop.
|
18
|
+
*/
|
19
|
+
emptyStateText?: React.ReactNode | false;
|
20
|
+
/**
|
21
|
+
* A custom function used to filter the options in the array passed to the `items` prop.
|
22
|
+
* By default, we filter out items that don't match the value of the autocomplete text input. The default filter is not case-sensitive.
|
23
|
+
*/
|
24
|
+
filterFn?: (item: T, i: number) => boolean;
|
25
|
+
/**
|
26
|
+
* The options for field values that are displayed in the dropdown menu.
|
27
|
+
* One or more may be selected depending on the value of the `selectionVariant` prop.
|
28
|
+
*/
|
29
|
+
items: T[];
|
30
|
+
/**
|
31
|
+
* Whether the data is loaded for the menu items
|
32
|
+
*/
|
33
|
+
loading?: boolean;
|
34
|
+
/**
|
35
|
+
* The IDs of the selected items
|
36
|
+
*/
|
37
|
+
selectedItemIds: Array<string | number>;
|
38
|
+
/**
|
39
|
+
* The sort function that is applied to the options in the array passed to the `items` prop after the user closes the menu.
|
40
|
+
* By default, selected items are sorted to the top after the user closes the menu.
|
41
|
+
*/
|
42
|
+
sortOnCloseFn?: (itemIdA: string | number, itemIdB: string | number) => number;
|
43
|
+
/**
|
44
|
+
* Whether there can be one item selected from the menu or multiple items selected from the menu
|
45
|
+
*/
|
46
|
+
selectionVariant?: 'single' | 'multiple';
|
47
|
+
/**
|
48
|
+
* Function that gets called when the menu is opened or closed
|
49
|
+
*/
|
50
|
+
onOpenChange?: (open: boolean) => void;
|
51
|
+
/**
|
52
|
+
* The function that is called when an item in the list is selected or deselected
|
53
|
+
*/
|
54
|
+
onSelectedChange?: OnSelectedChange<T>;
|
55
|
+
/**
|
56
|
+
* If the menu is rendered in a scrolling element other than the `Autocomplete.Overlay` component,
|
57
|
+
* pass the ref of that element to `customScrollContainerRef` to ensure the container automatically
|
58
|
+
* scrolls when the user highlights an item in the menu that is outside the scroll container
|
59
|
+
*/
|
60
|
+
customScrollContainerRef?: React.MutableRefObject<HTMLElement | null>;
|
61
|
+
} & Pick<React.AriaAttributes, 'aria-labelledby'>;
|
62
|
+
declare function AutocompleteMenu<T extends AutocompleteItemProps>(props: AutocompleteMenuInternalProps<T>): JSX.Element;
|
63
|
+
declare namespace AutocompleteMenu {
|
64
|
+
var defaultProps: {
|
65
|
+
emptyStateText: string;
|
66
|
+
selectionVariant: string;
|
67
|
+
};
|
68
|
+
var displayName: string;
|
69
|
+
}
|
70
|
+
export declare type AutocompleteMenuProps = ComponentProps<typeof AutocompleteMenu>;
|
71
|
+
export default AutocompleteMenu;
|