@react-aria/searchfield 3.0.0-nightly-641446f65-240905
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/README.md +3 -0
- package/dist/ar-AE.main.js +6 -0
- package/dist/ar-AE.main.js.map +1 -0
- package/dist/ar-AE.mjs +8 -0
- package/dist/ar-AE.module.js +8 -0
- package/dist/ar-AE.module.js.map +1 -0
- package/dist/bg-BG.main.js +6 -0
- package/dist/bg-BG.main.js.map +1 -0
- package/dist/bg-BG.mjs +8 -0
- package/dist/bg-BG.module.js +8 -0
- package/dist/bg-BG.module.js.map +1 -0
- package/dist/cs-CZ.main.js +6 -0
- package/dist/cs-CZ.main.js.map +1 -0
- package/dist/cs-CZ.mjs +8 -0
- package/dist/cs-CZ.module.js +8 -0
- package/dist/cs-CZ.module.js.map +1 -0
- package/dist/da-DK.main.js +6 -0
- package/dist/da-DK.main.js.map +1 -0
- package/dist/da-DK.mjs +8 -0
- package/dist/da-DK.module.js +8 -0
- package/dist/da-DK.module.js.map +1 -0
- package/dist/de-DE.main.js +6 -0
- package/dist/de-DE.main.js.map +1 -0
- package/dist/de-DE.mjs +8 -0
- package/dist/de-DE.module.js +8 -0
- package/dist/de-DE.module.js.map +1 -0
- package/dist/el-GR.main.js +6 -0
- package/dist/el-GR.main.js.map +1 -0
- package/dist/el-GR.mjs +8 -0
- package/dist/el-GR.module.js +8 -0
- package/dist/el-GR.module.js.map +1 -0
- package/dist/en-US.main.js +6 -0
- package/dist/en-US.main.js.map +1 -0
- package/dist/en-US.mjs +8 -0
- package/dist/en-US.module.js +8 -0
- package/dist/en-US.module.js.map +1 -0
- package/dist/es-ES.main.js +6 -0
- package/dist/es-ES.main.js.map +1 -0
- package/dist/es-ES.mjs +8 -0
- package/dist/es-ES.module.js +8 -0
- package/dist/es-ES.module.js.map +1 -0
- package/dist/et-EE.main.js +6 -0
- package/dist/et-EE.main.js.map +1 -0
- package/dist/et-EE.mjs +8 -0
- package/dist/et-EE.module.js +8 -0
- package/dist/et-EE.module.js.map +1 -0
- package/dist/fi-FI.main.js +6 -0
- package/dist/fi-FI.main.js.map +1 -0
- package/dist/fi-FI.mjs +8 -0
- package/dist/fi-FI.module.js +8 -0
- package/dist/fi-FI.module.js.map +1 -0
- package/dist/fr-FR.main.js +6 -0
- package/dist/fr-FR.main.js.map +1 -0
- package/dist/fr-FR.mjs +8 -0
- package/dist/fr-FR.module.js +8 -0
- package/dist/fr-FR.module.js.map +1 -0
- package/dist/he-IL.main.js +6 -0
- package/dist/he-IL.main.js.map +1 -0
- package/dist/he-IL.mjs +8 -0
- package/dist/he-IL.module.js +8 -0
- package/dist/he-IL.module.js.map +1 -0
- package/dist/hr-HR.main.js +6 -0
- package/dist/hr-HR.main.js.map +1 -0
- package/dist/hr-HR.mjs +8 -0
- package/dist/hr-HR.module.js +8 -0
- package/dist/hr-HR.module.js.map +1 -0
- package/dist/hu-HU.main.js +6 -0
- package/dist/hu-HU.main.js.map +1 -0
- package/dist/hu-HU.mjs +8 -0
- package/dist/hu-HU.module.js +8 -0
- package/dist/hu-HU.module.js.map +1 -0
- package/dist/import.mjs +17 -0
- package/dist/intlStrings.main.js +108 -0
- package/dist/intlStrings.main.js.map +1 -0
- package/dist/intlStrings.mjs +110 -0
- package/dist/intlStrings.module.js +110 -0
- package/dist/intlStrings.module.js.map +1 -0
- package/dist/it-IT.main.js +6 -0
- package/dist/it-IT.main.js.map +1 -0
- package/dist/it-IT.mjs +8 -0
- package/dist/it-IT.module.js +8 -0
- package/dist/it-IT.module.js.map +1 -0
- package/dist/ja-JP.main.js +6 -0
- package/dist/ja-JP.main.js.map +1 -0
- package/dist/ja-JP.mjs +8 -0
- package/dist/ja-JP.module.js +8 -0
- package/dist/ja-JP.module.js.map +1 -0
- package/dist/ko-KR.main.js +6 -0
- package/dist/ko-KR.main.js.map +1 -0
- package/dist/ko-KR.mjs +8 -0
- package/dist/ko-KR.module.js +8 -0
- package/dist/ko-KR.module.js.map +1 -0
- package/dist/lt-LT.main.js +6 -0
- package/dist/lt-LT.main.js.map +1 -0
- package/dist/lt-LT.mjs +8 -0
- package/dist/lt-LT.module.js +8 -0
- package/dist/lt-LT.module.js.map +1 -0
- package/dist/lv-LV.main.js +6 -0
- package/dist/lv-LV.main.js.map +1 -0
- package/dist/lv-LV.mjs +8 -0
- package/dist/lv-LV.module.js +8 -0
- package/dist/lv-LV.module.js.map +1 -0
- package/dist/main.js +22 -0
- package/dist/main.js.map +1 -0
- package/dist/module.js +17 -0
- package/dist/module.js.map +1 -0
- package/dist/nb-NO.main.js +6 -0
- package/dist/nb-NO.main.js.map +1 -0
- package/dist/nb-NO.mjs +8 -0
- package/dist/nb-NO.module.js +8 -0
- package/dist/nb-NO.module.js.map +1 -0
- package/dist/nl-NL.main.js +6 -0
- package/dist/nl-NL.main.js.map +1 -0
- package/dist/nl-NL.mjs +8 -0
- package/dist/nl-NL.module.js +8 -0
- package/dist/nl-NL.module.js.map +1 -0
- package/dist/pl-PL.main.js +6 -0
- package/dist/pl-PL.main.js.map +1 -0
- package/dist/pl-PL.mjs +8 -0
- package/dist/pl-PL.module.js +8 -0
- package/dist/pl-PL.module.js.map +1 -0
- package/dist/pt-BR.main.js +6 -0
- package/dist/pt-BR.main.js.map +1 -0
- package/dist/pt-BR.mjs +8 -0
- package/dist/pt-BR.module.js +8 -0
- package/dist/pt-BR.module.js.map +1 -0
- package/dist/pt-PT.main.js +6 -0
- package/dist/pt-PT.main.js.map +1 -0
- package/dist/pt-PT.mjs +8 -0
- package/dist/pt-PT.module.js +8 -0
- package/dist/pt-PT.module.js.map +1 -0
- package/dist/ro-RO.main.js +6 -0
- package/dist/ro-RO.main.js.map +1 -0
- package/dist/ro-RO.mjs +8 -0
- package/dist/ro-RO.module.js +8 -0
- package/dist/ro-RO.module.js.map +1 -0
- package/dist/ru-RU.main.js +6 -0
- package/dist/ru-RU.main.js.map +1 -0
- package/dist/ru-RU.mjs +8 -0
- package/dist/ru-RU.module.js +8 -0
- package/dist/ru-RU.module.js.map +1 -0
- package/dist/sk-SK.main.js +6 -0
- package/dist/sk-SK.main.js.map +1 -0
- package/dist/sk-SK.mjs +8 -0
- package/dist/sk-SK.module.js +8 -0
- package/dist/sk-SK.module.js.map +1 -0
- package/dist/sl-SI.main.js +6 -0
- package/dist/sl-SI.main.js.map +1 -0
- package/dist/sl-SI.mjs +8 -0
- package/dist/sl-SI.module.js +8 -0
- package/dist/sl-SI.module.js.map +1 -0
- package/dist/sr-SP.main.js +6 -0
- package/dist/sr-SP.main.js.map +1 -0
- package/dist/sr-SP.mjs +8 -0
- package/dist/sr-SP.module.js +8 -0
- package/dist/sr-SP.module.js.map +1 -0
- package/dist/sv-SE.main.js +6 -0
- package/dist/sv-SE.main.js.map +1 -0
- package/dist/sv-SE.mjs +8 -0
- package/dist/sv-SE.module.js +8 -0
- package/dist/sv-SE.module.js.map +1 -0
- package/dist/tr-TR.main.js +6 -0
- package/dist/tr-TR.main.js.map +1 -0
- package/dist/tr-TR.mjs +8 -0
- package/dist/tr-TR.module.js +8 -0
- package/dist/tr-TR.module.js.map +1 -0
- package/dist/types.d.ts +27 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/uk-UA.main.js +6 -0
- package/dist/uk-UA.main.js.map +1 -0
- package/dist/uk-UA.mjs +8 -0
- package/dist/uk-UA.module.js +8 -0
- package/dist/uk-UA.module.js.map +1 -0
- package/dist/useSearchField.main.js +90 -0
- package/dist/useSearchField.main.js.map +1 -0
- package/dist/useSearchField.mjs +85 -0
- package/dist/useSearchField.module.js +85 -0
- package/dist/useSearchField.module.js.map +1 -0
- package/dist/zh-CN.main.js +6 -0
- package/dist/zh-CN.main.js.map +1 -0
- package/dist/zh-CN.mjs +8 -0
- package/dist/zh-CN.module.js +8 -0
- package/dist/zh-CN.module.js.map +1 -0
- package/dist/zh-TW.main.js +6 -0
- package/dist/zh-TW.main.js.map +1 -0
- package/dist/zh-TW.mjs +8 -0
- package/dist/zh-TW.module.js +8 -0
- package/dist/zh-TW.module.js.map +1 -0
- package/package.json +41 -0
- package/src/index.ts +14 -0
- package/src/useSearchField.ts +128 -0
package/dist/zh-CN.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":";AAAA,4BAAiB;IAAG,gBAAgB,CAAC,gCAAI,CAAC;AAC1C","sources":["packages/@react-aria/searchfield/intl/zh-CN.json"],"sourcesContent":["{\n \"Clear search\": \"清除搜索\"\n}\n"],"names":[],"version":3,"file":"zh-CN.module.js.map"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAAA,iBAAiB;IAAG,gBAAgB,CAAC,gDAAM,CAAC;AAC5C","sources":["packages/@react-aria/searchfield/intl/zh-TW.json"],"sourcesContent":["{\n \"Clear search\": \"清除搜尋條件\"\n}\n"],"names":[],"version":3,"file":"zh-TW.main.js.map"}
|
package/dist/zh-TW.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":";AAAA,4BAAiB;IAAG,gBAAgB,CAAC,gDAAM,CAAC;AAC5C","sources":["packages/@react-aria/searchfield/intl/zh-TW.json"],"sourcesContent":["{\n \"Clear search\": \"清除搜尋條件\"\n}\n"],"names":[],"version":3,"file":"zh-TW.module.js.map"}
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@react-aria/searchfield",
|
|
3
|
+
"version": "3.0.0-nightly-641446f65-240905",
|
|
4
|
+
"description": "Spectrum UI components in React",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"main": "dist/main.js",
|
|
7
|
+
"module": "dist/module.js",
|
|
8
|
+
"exports": {
|
|
9
|
+
"types": "./dist/types.d.ts",
|
|
10
|
+
"import": "./dist/import.mjs",
|
|
11
|
+
"require": "./dist/main.js"
|
|
12
|
+
},
|
|
13
|
+
"types": "dist/types.d.ts",
|
|
14
|
+
"source": "src/index.ts",
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"src"
|
|
18
|
+
],
|
|
19
|
+
"sideEffects": false,
|
|
20
|
+
"repository": {
|
|
21
|
+
"type": "git",
|
|
22
|
+
"url": "https://github.com/adobe/react-spectrum"
|
|
23
|
+
},
|
|
24
|
+
"dependencies": {
|
|
25
|
+
"@react-aria/i18n": "^3.0.0-nightly-641446f65-240905",
|
|
26
|
+
"@react-aria/textfield": "^3.0.0-nightly-641446f65-240905",
|
|
27
|
+
"@react-aria/utils": "^3.0.0-nightly-641446f65-240905",
|
|
28
|
+
"@react-stately/searchfield": "^3.0.0-nightly-641446f65-240905",
|
|
29
|
+
"@react-types/button": "^3.0.0-nightly-641446f65-240905",
|
|
30
|
+
"@react-types/searchfield": "^3.0.0-nightly-641446f65-240905",
|
|
31
|
+
"@react-types/shared": "^3.0.0-nightly-641446f65-240905",
|
|
32
|
+
"@swc/helpers": "^0.5.0"
|
|
33
|
+
},
|
|
34
|
+
"peerDependencies": {
|
|
35
|
+
"react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0"
|
|
36
|
+
},
|
|
37
|
+
"publishConfig": {
|
|
38
|
+
"access": "public"
|
|
39
|
+
},
|
|
40
|
+
"stableVersion": "3.7.8"
|
|
41
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2020 Adobe. All rights reserved.
|
|
3
|
+
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
* you may not use this file except in compliance with the License. You may obtain a copy
|
|
5
|
+
* of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
6
|
+
*
|
|
7
|
+
* Unless required by applicable law or agreed to in writing, software distributed under
|
|
8
|
+
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
9
|
+
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
10
|
+
* governing permissions and limitations under the License.
|
|
11
|
+
*/
|
|
12
|
+
export {useSearchField} from './useSearchField';
|
|
13
|
+
export type {AriaSearchFieldProps} from '@react-types/searchfield';
|
|
14
|
+
export type {SearchFieldAria} from './useSearchField';
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2020 Adobe. All rights reserved.
|
|
3
|
+
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
* you may not use this file except in compliance with the License. You may obtain a copy
|
|
5
|
+
* of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
6
|
+
*
|
|
7
|
+
* Unless required by applicable law or agreed to in writing, software distributed under
|
|
8
|
+
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
9
|
+
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
10
|
+
* governing permissions and limitations under the License.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import {AriaButtonProps} from '@react-types/button';
|
|
14
|
+
import {AriaSearchFieldProps} from '@react-types/searchfield';
|
|
15
|
+
import {chain} from '@react-aria/utils';
|
|
16
|
+
import {DOMAttributes, RefObject, ValidationResult} from '@react-types/shared';
|
|
17
|
+
import {InputHTMLAttributes, LabelHTMLAttributes} from 'react';
|
|
18
|
+
// @ts-ignore
|
|
19
|
+
import intlMessages from '../intl/*.json';
|
|
20
|
+
import {SearchFieldState} from '@react-stately/searchfield';
|
|
21
|
+
import {useLocalizedStringFormatter} from '@react-aria/i18n';
|
|
22
|
+
import {useTextField} from '@react-aria/textfield';
|
|
23
|
+
|
|
24
|
+
export interface SearchFieldAria extends ValidationResult {
|
|
25
|
+
/** Props for the text field's visible label element (if any). */
|
|
26
|
+
labelProps: LabelHTMLAttributes<HTMLLabelElement>,
|
|
27
|
+
/** Props for the input element. */
|
|
28
|
+
inputProps: InputHTMLAttributes<HTMLInputElement>,
|
|
29
|
+
/** Props for the clear button. */
|
|
30
|
+
clearButtonProps: AriaButtonProps,
|
|
31
|
+
/** Props for the searchfield's description element, if any. */
|
|
32
|
+
descriptionProps: DOMAttributes,
|
|
33
|
+
/** Props for the searchfield's error message element, if any. */
|
|
34
|
+
errorMessageProps: DOMAttributes
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Provides the behavior and accessibility implementation for a search field.
|
|
39
|
+
* @param props - Props for the search field.
|
|
40
|
+
* @param state - State for the search field, as returned by `useSearchFieldState`.
|
|
41
|
+
* @param inputRef - A ref to the input element.
|
|
42
|
+
*/
|
|
43
|
+
export function useSearchField(
|
|
44
|
+
props: AriaSearchFieldProps,
|
|
45
|
+
state: SearchFieldState,
|
|
46
|
+
inputRef: RefObject<HTMLInputElement | null>
|
|
47
|
+
): SearchFieldAria {
|
|
48
|
+
let stringFormatter = useLocalizedStringFormatter(intlMessages, '@react-aria/searchfield');
|
|
49
|
+
let {
|
|
50
|
+
isDisabled,
|
|
51
|
+
isReadOnly,
|
|
52
|
+
onSubmit,
|
|
53
|
+
onClear,
|
|
54
|
+
type = 'search'
|
|
55
|
+
} = props;
|
|
56
|
+
|
|
57
|
+
let onKeyDown = (e) => {
|
|
58
|
+
const key = e.key;
|
|
59
|
+
|
|
60
|
+
if (key === 'Enter' && (isDisabled || isReadOnly)) {
|
|
61
|
+
e.preventDefault();
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
if (isDisabled || isReadOnly) {
|
|
65
|
+
return;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// for backward compatibility;
|
|
69
|
+
// otherwise, "Enter" on an input would trigger a form submit, the default browser behavior
|
|
70
|
+
if (key === 'Enter' && onSubmit) {
|
|
71
|
+
e.preventDefault();
|
|
72
|
+
onSubmit(state.value);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
if (key === 'Escape') {
|
|
76
|
+
if (state.value === '') {
|
|
77
|
+
e.continuePropagation();
|
|
78
|
+
} else {
|
|
79
|
+
state.setValue('');
|
|
80
|
+
if (onClear) {
|
|
81
|
+
onClear();
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
let onClearButtonClick = () => {
|
|
88
|
+
state.setValue('');
|
|
89
|
+
|
|
90
|
+
if (onClear) {
|
|
91
|
+
onClear();
|
|
92
|
+
}
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
let onPressStart = () => {
|
|
96
|
+
// this is in PressStart for mobile so that touching the clear button doesn't remove focus from
|
|
97
|
+
// the input and close the keyboard
|
|
98
|
+
inputRef.current?.focus();
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
let {labelProps, inputProps, descriptionProps, errorMessageProps, ...validation} = useTextField({
|
|
102
|
+
...props,
|
|
103
|
+
value: state.value,
|
|
104
|
+
onChange: state.setValue,
|
|
105
|
+
onKeyDown: !isReadOnly ? chain(onKeyDown, props.onKeyDown) : props.onKeyDown,
|
|
106
|
+
type
|
|
107
|
+
}, inputRef);
|
|
108
|
+
|
|
109
|
+
return {
|
|
110
|
+
labelProps,
|
|
111
|
+
inputProps: {
|
|
112
|
+
...inputProps,
|
|
113
|
+
// already handled by useSearchFieldState
|
|
114
|
+
defaultValue: undefined
|
|
115
|
+
},
|
|
116
|
+
clearButtonProps: {
|
|
117
|
+
'aria-label': stringFormatter.format('Clear search'),
|
|
118
|
+
excludeFromTabOrder: true,
|
|
119
|
+
preventFocusOnPress: true,
|
|
120
|
+
isDisabled: isDisabled || isReadOnly,
|
|
121
|
+
onPress: onClearButtonClick,
|
|
122
|
+
onPressStart
|
|
123
|
+
},
|
|
124
|
+
descriptionProps,
|
|
125
|
+
errorMessageProps,
|
|
126
|
+
...validation
|
|
127
|
+
};
|
|
128
|
+
}
|