Open History to see the last commit
1import {
2 Combobox,
3 TagsInput,
4 createListCollection,
5 useCombobox,
6 useTagsInput,
7} from '@ark-ui/solid'
8import fuzzysort from 'fuzzysort'
9import BookmarkIcon from 'lucide-solid/icons/bookmark'
10import CheckIcon from 'lucide-solid/icons/check'
11import EqualIcon from 'lucide-solid/icons/equal'
12import EqualNotIcon from 'lucide-solid/icons/equal-not'
13import EyeClosedIcon from 'lucide-solid/icons/eye-closed'
14import EyeIcon from 'lucide-solid/icons/eye'
15import ListTreeIcon from 'lucide-solid/icons/list-tree'
16import PencilIcon from 'lucide-solid/icons/pencil'
17import PencilSparklesIcon from 'lucide-solid/icons/pencil-sparkles'
18import PointerIcon from 'lucide-solid/icons/pointer'
19import PointerOffIcon from 'lucide-solid/icons/pointer-off'
20import SquareArrowRightExitIcon from 'lucide-solid/icons/square-arrow-right-exit'
21import SquareIcon from 'lucide-solid/icons/square'
22import XIcon from 'lucide-solid/icons/x'
23import {
24 createEffect,
25 createMemo,
26 createSignal,
27 createUniqueId,
28 onCleanup,
29} from 'solid-js'
30import type { Accessor, ParentProps, Setter } from 'solid-js'
31import type { LucideIcon } from 'lucide-solid'
32import type { FieldRowFilterPredicate } from '@/stores/fieldListStore'
33import {
34 createFieldSummaryFilterPredicate,
35 isFieldPinned,
36} from '@/stores/fieldListStore'
37β
38const mentionRegex = /(?:^|\s)@(\S*)/
39β
40type FieldFilterGroup =
41 | 'dirty'
42 | 'bookmarked'
43 | 'valid'
44 | 'mounted'
45 | 'touched'
46 | 'blurred'
47 | 'defaultValue'
48β
49export interface FieldListFilter {
50 id: string
51 label: string
52 group: FieldFilterGroup
53 icon: LucideIcon
54 description: string
55 aliases?: Array<string>
56 predicate?: FieldRowFilterPredicate
57}
58β
59function createMountedFilterPredicate(
60 predicate: FieldRowFilterPredicate,
61): FieldRowFilterPredicate {
62 predicate.bypassesDefaultInclusion = true
63 return predicate
64}
65β
66const allFieldFilters: Array<FieldListFilter> = [
67 {
68 label: 'Invalid',
69 id: 'invalid',
70 group: 'valid',
71 aliases: ['Not valid', 'Errors'],
72 description: 'Has shown or hidden errors',
73 icon: XIcon,
74 predicate: createFieldSummaryFilterPredicate(
75 (_field, summary) => summary.validity !== 'valid',
76 ),
77 },
78 {
79 label: 'Valid',
80 id: 'valid',
81 group: 'valid',
82 aliases: ['Not invalid', 'No errors'],
83 description: 'Has no stored errors',
84 icon: CheckIcon,
85 predicate: createFieldSummaryFilterPredicate(
86 (_field, summary) => summary.validity === 'valid',
87 ),
88 },
89 {
90 label: 'Dirty',
91 id: 'dirty',
92 group: 'dirty',
93 aliases: ['Not pristine', 'Not clean', 'Unclean', 'Changed'],
94 description: 'Has been dirtied',
95 icon: PencilIcon,
96 predicate: createFieldSummaryFilterPredicate(
97 (_field, summary) => summary.isDirty,
98 ),
99 },
100 {
101 label: 'Pristine',
102 id: 'pristine',
103 group: 'dirty',
104 aliases: ['Not dirty', 'Clean', 'Unchanged'],
105 description: 'Has not been dirtied',
106 icon: PencilSparklesIcon,
107 predicate: createFieldSummaryFilterPredicate(
108 (_field, summary) => !summary.isDirty,
109 ),
110 },
111 {
112 label: 'Touched',
113 id: 'touched',
114 group: 'touched',
115 aliases: ['Changed', 'Blurred'],
116 description: 'Has been touched, either by change or blur',
117 icon: PointerIcon,
118 predicate: createFieldSummaryFilterPredicate(
119 (_field, summary) => summary.isTouched,
120 ),
121 },
122 {
123 label: 'Untouched',
124 id: 'untouched',
125 group: 'touched',
126 aliases: ['Not Changed', 'Not Blurred'],
127 description: 'Has not been changed or blurred',
128 icon: PointerOffIcon,
129 predicate: createFieldSummaryFilterPredicate(
130 (_field, summary) => !summary.isTouched,
131 ),
132 },
133 {
134 label: 'Blurred',
135 id: 'blurred',
136 group: 'blurred',
137 aliases: ['Was blurred', 'Visited'],
138 description: 'Has lost focus at least once',
139 icon: SquareArrowRightExitIcon,
140 predicate: createFieldSummaryFilterPredicate(
141 (_field, summary) => summary.isBlurred,
142 ),
143 },
144 {
145 label: 'Not blurred',
146 id: 'not-blurred',
147 group: 'blurred',
148 aliases: ['Never blurred', 'Not visited', 'Unblurred'],
149 description: 'Was not focused or has not lost it yet',
150 icon: SquareIcon,
151 predicate: createFieldSummaryFilterPredicate(
152 (_field, summary) => !summary.isBlurred,
153 ),
154 },
155 {
156 label: 'Default value',
157 id: 'default-value',
158 group: 'defaultValue',
159 aliases: ['Initial value', 'Unchanged value', 'Same value'],
160 description: 'Matches its default value',
161 icon: EqualIcon,
162 predicate: createFieldSummaryFilterPredicate(
163 (_field, summary) => summary.isDefaultValue,
164 ),
165 },
166 {
167 label: 'Non-default value',
168 id: 'non-default-value',
169 group: 'defaultValue',
170 aliases: ['Modified value', 'Changed value', 'Different value'],
171 description: 'Does not match its default value',
172 icon: EqualNotIcon,
173 predicate: createFieldSummaryFilterPredicate(
174 (_field, summary) => !summary.isDefaultValue,
175 ),
176 },
177 {
178 label: 'Bookmarked',
179 id: 'bookmarked',
180 group: 'bookmarked',
181 aliases: ['Pinned', 'Selected'],
182 description: 'Is bookmarked in the devtools',
183 icon: BookmarkIcon,
184 predicate: (field) => isFieldPinned(field.fieldId),
185 },
186 {
187 label: 'Rendered',
188 id: 'mounted',
189 group: 'mounted',
190 aliases: ['Visible', 'Mounted'],
191 description: 'Is mounted in a component',
192 icon: EyeIcon,
193 predicate: createMountedFilterPredicate(
194 (field) => field.isMounted !== false,
195 ),
196 },
197 {
198 label: 'Not Rendered',
199 id: 'unmounted',
200 group: 'mounted',
201 aliases: ['Invisible', 'Not mounted', 'Unrendered'],
202 description: 'Is not currently mounted in a component',
203 icon: EyeClosedIcon,
204 predicate: createMountedFilterPredicate(
205 (field) => field.isMounted === false,
206 ),
207 },
208 {
209 label: 'All',
210 id: 'all',
211 group: 'mounted',
212 description: 'All registered fields, whether rendered or unrendered',
213 icon: ListTreeIcon,
214 predicate: createMountedFilterPredicate(() => true),
215 },
216]
217β
218function suggestFilters(
219 query: string,
220 suggestions: Array<FieldListFilter>,
221): Array<FieldListFilter> {
222 const keysResults = fuzzysort.go(query, suggestions, {
223 keys: ['label', 'description', (filter) => filter.aliases?.join() ?? ''],
224 limit: 0,
225 threshold: 0.3,
226 scoreFn: (results) => {
227 const labelScore = results[0]?.score ?? 0
228 const descriptionScore = results[1]?.score ?? 0
229 const aliasScore = results[2]?.score ?? 0
230β
231 return Math.max(labelScore, aliasScore * 0.85, descriptionScore * 0.5)
232 },
233 })
234 return keysResults.map((result) => result.obj)
235}
236β
237function getFilters(selection: Array<string>): Array<FieldListFilter> {
238 return selection
239 .map((s) => allFieldFilters.find((filter) => filter.id === s))
240 .filter((filter) => filter !== undefined)
241}
242β
243interface FieldListSearchArgs {
244 query: Accessor<string>
245 setQuery: Setter<string>
246 setFilterPipeline: Setter<Array<FieldRowFilterPredicate>>
247}
248β
249export function createFieldListSearch({
250 query,
251 setQuery,
252 setFilterPipeline,
253}: FieldListSearchArgs) {
254 const uid = createUniqueId()
255 const ids = {
256 input: `input_${uid}`,
257 control: `control_${uid}`,
258 }
259β
260 const [selectedTags, setSelectedTags] = createSignal<Array<FieldListFilter>>(
261 [],
262 )
263β
264 createEffect(() => {
265 setFilterPipeline(
266 selectedTags().flatMap((filter) =>
267 filter.predicate ? [filter.predicate] : [],
268 ),
269 )
270 })
271β
272 onCleanup(() => setFilterPipeline([]))
273β
274 const activeMention = createMemo(() => {
275 const match = query().match(mentionRegex)
276 return match?.[1] ?? null
277 })
278β
279 const remainingFilters = createMemo(() => {
280 const selected = selectedTags()
281 if (selected.length === 0) return allFieldFilters
282 return allFieldFilters.filter((f) =>
283 selected.every((s) => s.group !== f.group),
284 )
285 })
286β
287 const tagsCollection = createMemo(() =>
288 createListCollection<FieldListFilter>({
289 items: suggestFilters(activeMention() ?? '', remainingFilters()),
290 itemToString: (item) => item.label,
291 itemToValue: (item) => item.id,
292 }),
293 )
294β
295 const tagsInputApi = useTagsInput(() => ({
296 ids,
297β
298 value: selectedTags().map((v) => v.id),
299β
300 onValueChange(details) {
301 setSelectedTags(getFilters(details.value))
302 },
303β
304 inputValue: query(),
305 onInputValueChange(details) {
306 setQuery(details.inputValue)
307 },
308β
309 delimiter: /$disable Delimeter/,
310 addOnPaste: false,
311 editable: false,
312 }))
313β
314 function replaceActiveMention() {
315 setQuery((prev) => prev.replace(mentionRegex, ''))
316 }
317β
318 const comboboxApi = useCombobox(() => ({
319 ids,
320β
321 collection: tagsCollection(),
322 disableLayer: true,
323β
324 inputValue: query(),
325 value: [],
326β
327 open: activeMention() !== null,
328 openOnClick: false,
329 openOnKeyPress: false,
330β
331 allowCustomValue: true,
332 inputBehavior: 'autohighlight',
333 selectionBehavior: 'preserve',
334β
335 onValueChange(details) {
336 const selected = details.value[0]
337β
338 if (!selected) return
339β
340 tagsInputApi().addValue(selected)
341 replaceActiveMention()
342 },
343β
344 scrollToIndexFn: ({ getElement }) => {
345 requestAnimationFrame(() => {
346 getElement()?.scrollIntoView({
347 block: 'nearest',
348 inline: 'nearest',
349 behavior: 'auto',
350 })
351 })
352 },
353 }))
354β
355 const clearSelection = () => {
356 setQuery('')
357 setSelectedTags([])
358 }
359β
360 const hasFilters = () => selectedTags().length > 0 || query().length > 0
361β
362 function Provider(props: ParentProps) {
363 return (
364 <TagsInput.RootProvider value={tagsInputApi}>
365 <Combobox.RootProvider value={comboboxApi}>
366 {props.children}
367 </Combobox.RootProvider>
368 </TagsInput.RootProvider>
369 )
370 }
371β
372 return {
373 tagsInputApi,
374 comboboxApi,
375 Provider,
376 selectedTags,
377 clearSelection,
378 hasFilters,
379 tagsSuggestions: tagsCollection,
380 }
381}