@react-fabric/searchbar 1.0.0-beta.0

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.
Files changed (57) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +10 -0
  3. package/dist/cjs/filterbar/Context.js +34 -0
  4. package/dist/cjs/filterbar/FilterBar.js +149 -0
  5. package/dist/cjs/filterbar/FilterEdit.js +51 -0
  6. package/dist/cjs/filterbar/FilterForm.js +262 -0
  7. package/dist/cjs/filterbar/FilterMenu.js +80 -0
  8. package/dist/cjs/filterbar/FilterTag.js +93 -0
  9. package/dist/cjs/filterbar/FilterView.js +88 -0
  10. package/dist/cjs/filterbar/QueryForm.js +135 -0
  11. package/dist/cjs/i18n/ar.json.js +84 -0
  12. package/dist/cjs/i18n/en.json.js +84 -0
  13. package/dist/cjs/i18n/index.js +33 -0
  14. package/dist/cjs/index.js +11 -0
  15. package/dist/cjs/searchbar/SearchBar.js +154 -0
  16. package/dist/cjs/types/index.js +70 -0
  17. package/dist/esm/filterbar/Context.js +33 -0
  18. package/dist/esm/filterbar/FilterBar.js +149 -0
  19. package/dist/esm/filterbar/FilterEdit.js +51 -0
  20. package/dist/esm/filterbar/FilterForm.js +262 -0
  21. package/dist/esm/filterbar/FilterMenu.js +80 -0
  22. package/dist/esm/filterbar/FilterTag.js +93 -0
  23. package/dist/esm/filterbar/FilterView.js +88 -0
  24. package/dist/esm/filterbar/QueryForm.js +135 -0
  25. package/dist/esm/i18n/ar.json.js +77 -0
  26. package/dist/esm/i18n/en.json.js +77 -0
  27. package/dist/esm/i18n/index.js +33 -0
  28. package/dist/esm/index.js +5 -0
  29. package/dist/esm/searchbar/SearchBar.js +154 -0
  30. package/dist/esm/types/index.js +68 -0
  31. package/dist/types/filterbar/Context.d.ts +4 -0
  32. package/dist/types/filterbar/FilterBar.d.ts +2 -0
  33. package/dist/types/filterbar/FilterEdit.d.ts +6 -0
  34. package/dist/types/filterbar/FilterForm.d.ts +6 -0
  35. package/dist/types/filterbar/FilterMenu.d.ts +7 -0
  36. package/dist/types/filterbar/FilterTag.d.ts +6 -0
  37. package/dist/types/filterbar/FilterView.d.ts +5 -0
  38. package/dist/types/filterbar/QueryForm.d.ts +6 -0
  39. package/dist/types/i18n/index.d.ts +1 -0
  40. package/dist/types/index.d.ts +3 -0
  41. package/dist/types/searchbar/SearchBar.d.ts +2 -0
  42. package/dist/types/types/index.d.ts +203 -0
  43. package/package.json +56 -0
  44. package/src/filterbar/Context.tsx +31 -0
  45. package/src/filterbar/FilterBar.tsx +195 -0
  46. package/src/filterbar/FilterEdit.tsx +70 -0
  47. package/src/filterbar/FilterForm.tsx +281 -0
  48. package/src/filterbar/FilterMenu.tsx +100 -0
  49. package/src/filterbar/FilterTag.tsx +114 -0
  50. package/src/filterbar/FilterView.tsx +89 -0
  51. package/src/filterbar/QueryForm.tsx +151 -0
  52. package/src/i18n/ar.json +68 -0
  53. package/src/i18n/en.json +68 -0
  54. package/src/i18n/index.ts +28 -0
  55. package/src/index.ts +32 -0
  56. package/src/searchbar/SearchBar.tsx +162 -0
  57. package/src/types/index.ts +315 -0
@@ -0,0 +1,315 @@
1
+ /*
2
+ * React Fabric
3
+ * @version: 1.0.0
4
+ *
5
+ *
6
+ * The MIT License (MIT)
7
+ * Copyright (c) 2024 Adarsh Pastakia
8
+ *
9
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
10
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
11
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
12
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
13
+ * subject to the following conditions:
14
+ *
15
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
16
+ * portions of the Software.
17
+ *
18
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19
+ * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22
+ */
23
+
24
+ import { type ReactElement } from "react";
25
+
26
+ export enum FIELD_TYPE {
27
+ ID = "ID",
28
+ STRING = "STRING",
29
+ NUMBER = "NUMBER",
30
+ DECIMAL = "DECIMAL",
31
+ BOOLEAN = "BOOLEAN",
32
+ // DATE = "DATE",
33
+ // DATETIME = "DATETIME",
34
+ // GEO = "GEO",
35
+ NONE = "NONE",
36
+ }
37
+
38
+ export enum OPERATOR {
39
+ EXISTS = "EXISTS",
40
+ IS = "IS",
41
+ IN = "IN",
42
+ LT = "LT",
43
+ GT = "GT",
44
+ LTE = "LTE",
45
+ GTE = "GTE",
46
+ INCLUDES = "INCLUDES",
47
+ STARTS = "STARTS",
48
+ ENDS = "ENDS",
49
+ WITHIN = "WITHIN",
50
+ BETWEEN = "BETWEEN",
51
+ }
52
+
53
+ /**
54
+ * @internal
55
+ */
56
+ export const TypeOperators: { [key in FIELD_TYPE]: OPERATOR[] } = {
57
+ [FIELD_TYPE.ID]: [OPERATOR.IS],
58
+ [FIELD_TYPE.STRING]: [
59
+ OPERATOR.EXISTS,
60
+ OPERATOR.IS,
61
+ OPERATOR.IN,
62
+ OPERATOR.INCLUDES,
63
+ OPERATOR.STARTS,
64
+ OPERATOR.ENDS,
65
+ ],
66
+ [FIELD_TYPE.NUMBER]: [
67
+ OPERATOR.EXISTS,
68
+ OPERATOR.IS,
69
+ OPERATOR.BETWEEN,
70
+ OPERATOR.LT,
71
+ OPERATOR.GT,
72
+ OPERATOR.LTE,
73
+ OPERATOR.GTE,
74
+ ],
75
+ [FIELD_TYPE.DECIMAL]: [
76
+ OPERATOR.EXISTS,
77
+ OPERATOR.IS,
78
+ OPERATOR.BETWEEN,
79
+ OPERATOR.LT,
80
+ OPERATOR.GT,
81
+ OPERATOR.LTE,
82
+ OPERATOR.GTE,
83
+ ],
84
+ [FIELD_TYPE.BOOLEAN]: [OPERATOR.EXISTS, OPERATOR.IS],
85
+ // [FIELD_TYPE.DATE]: [
86
+ // OPERATOR.BETWEEN,
87
+ // OPERATOR.LT,
88
+ // OPERATOR.GT,
89
+ // OPERATOR.LTE,
90
+ // OPERATOR.GTE,
91
+ // ],
92
+ // [FIELD_TYPE.DATETIME]: [
93
+ // OPERATOR.BETWEEN,
94
+ // OPERATOR.LT,
95
+ // OPERATOR.GT,
96
+ // OPERATOR.LTE,
97
+ // OPERATOR.GTE,
98
+ // ],
99
+ // [FIELD_TYPE.GEO]: [],
100
+ [FIELD_TYPE.NONE]: [OPERATOR.EXISTS],
101
+ };
102
+
103
+ /**
104
+ * @internal
105
+ */
106
+ export const OperatorValueType: {
107
+ [key in OPERATOR]: 0 | 1 | 2;
108
+ } = {
109
+ [OPERATOR.EXISTS]: 0,
110
+ [OPERATOR.IS]: 0,
111
+ [OPERATOR.IN]: 1,
112
+ [OPERATOR.BETWEEN]: 2,
113
+ [OPERATOR.WITHIN]: 0,
114
+ [OPERATOR.STARTS]: 0,
115
+ [OPERATOR.ENDS]: 0,
116
+ [OPERATOR.INCLUDES]: 0,
117
+ [OPERATOR.LT]: 0,
118
+ [OPERATOR.GT]: 0,
119
+ [OPERATOR.LTE]: 0,
120
+ [OPERATOR.GTE]: 0,
121
+ };
122
+
123
+ /**
124
+ * @internal
125
+ */
126
+ export type FilterValue =
127
+ | undefined
128
+ | boolean
129
+ | string
130
+ | string[]
131
+ | number
132
+ | [number, number];
133
+
134
+ interface BaseFilter {
135
+ id: string;
136
+ icon?: string;
137
+ label?: string;
138
+ group?: string;
139
+ value?: FilterValue;
140
+ pinned?: boolean;
141
+ negate?: boolean;
142
+ disabled?: boolean;
143
+ required?: boolean;
144
+ canPin?: boolean;
145
+ canEdit?: boolean;
146
+ canInvert?: boolean;
147
+ canDisable?: boolean;
148
+ }
149
+
150
+ export type FilterObject = BaseFilter &
151
+ (
152
+ | {
153
+ field: string;
154
+ type?: FIELD_TYPE;
155
+ operator: OPERATOR;
156
+ value?: FilterValue;
157
+ query?: never;
158
+ }
159
+ | {
160
+ field?: never;
161
+ type?: never;
162
+ operator?: never;
163
+ label: string;
164
+ query: string;
165
+ }
166
+ );
167
+
168
+ export interface SearchObject {
169
+ query?: string | string[];
170
+ filters: FilterObject[];
171
+ }
172
+
173
+ export type FieldValue =
174
+ | string
175
+ | { value: string; label: string; icon?: AnyObject };
176
+
177
+ export interface FilterField {
178
+ field: string;
179
+ label: string;
180
+ type: FIELD_TYPE;
181
+ values?: FieldValue[];
182
+ defaultOperator?: OPERATOR;
183
+ onSearch?: (q: string) => Promise<FieldValue[]> | FieldValue[];
184
+ }
185
+
186
+ interface BaseSearchBarProps {
187
+ /**
188
+ * Query string
189
+ */
190
+ query?: AnyObject;
191
+ /**
192
+ * Search history count
193
+ * @default 20
194
+ */
195
+ historyCount?: number;
196
+
197
+ /**
198
+ * Search history storage key
199
+ * @default: "ax:search"
200
+ */
201
+ historyKey?: string;
202
+
203
+ /**
204
+ * Default query items for suggest
205
+ */
206
+ defaultQueryList?: string[];
207
+
208
+ /**
209
+ * Add-on before search input
210
+ */
211
+ prepend?: ReactElement;
212
+ /**
213
+ * Add-on after search input
214
+ */
215
+ append?: ReactElement;
216
+
217
+ /**
218
+ * Additional actions menu
219
+ */
220
+ actions?: ReactElement;
221
+
222
+ /**
223
+ * Hide filter bar
224
+ */
225
+ hideFilters?: boolean;
226
+
227
+ /**
228
+ * Disable component
229
+ */
230
+ disabled?: boolean;
231
+
232
+ /**
233
+ * Collapse filters
234
+ * @default true
235
+ */
236
+ defaultCollapsed?: boolean;
237
+ /**
238
+ *
239
+ */
240
+ decorateStart?: JSX.Element | string | number | boolean;
241
+ /**
242
+ *
243
+ */
244
+ decorateEnd?: JSX.Element | string | number | boolean;
245
+ /**
246
+ * On filter collapsed
247
+ * @param collapsed
248
+ */
249
+ onCollapsed?: (collapsed: boolean) => void;
250
+
251
+ /**
252
+ * On search event
253
+ * @param queryObject
254
+ */
255
+ onSearch?: (queryObject: SearchObject) => void;
256
+ /**
257
+ * On query string change event
258
+ * @param query
259
+ */
260
+ onQuery?: (query: string) => Promise<string[]> | string[];
261
+ }
262
+
263
+ export type SearchBarProps = BaseSearchBarProps &
264
+ (
265
+ | { multiple: true; query?: string[] }
266
+ | { multiple?: never | false; query?: string }
267
+ );
268
+
269
+ export interface FilterBarProps {
270
+ /**
271
+ * Filters list
272
+ * @default []
273
+ */
274
+ filters?: FilterObject[];
275
+
276
+ /**
277
+ * Field list
278
+ * (Required when filter bar enabled)
279
+ */
280
+ fields?: FilterField[];
281
+
282
+ /**
283
+ * Editable filters
284
+ */
285
+ isEditable?: boolean;
286
+
287
+ /**
288
+ * Disable component
289
+ */
290
+ isDisabled?: boolean;
291
+
292
+ /**
293
+ * Message for empty field list
294
+ */
295
+ emptyFields?: string;
296
+
297
+ /**
298
+ * included filter chip color
299
+ */
300
+ includedColor?: string;
301
+ /**
302
+ * excluded filter chip color
303
+ */
304
+ excludedColor?: string;
305
+
306
+ allowAdd?: boolean;
307
+ querySchema?: Array<{ uri: string; schema: KeyValue }>;
308
+ defaultQuery?: string;
309
+
310
+ /**
311
+ * On filters change, (add/update/delete)
312
+ * @param filters
313
+ */
314
+ onFilterChanged?: (filters: FilterObject[]) => void;
315
+ }