feat: add indexOf method for useFilter

[qmhc]

Add indexOf method for useFilter.

I have met a situation where it is necessary to filter options by the index of a substring, so it would be better if an indexOf method could be provided directly.

✅ Pull Request Checklist:

• Included link to corresponding React Spectrum GitHub Issue.
• Added/updated unit tests and storybook for this change (for new code or code which already has tests).
• Filled out test instructions.
• Updated documentation (if it already exists for this component).
• Looked at the Accessibility Practices for this feature - Aria Practices

📝 Test Instructions:

🧢 Your Project:

Currently I am using the following as a workaround:

const collator = useCollator({ usage: 'search', sensitivity: 'base' });
const indexOf = useCallback((string: string, substring: string) => {
  if (substring.length === 0) {
    return 0;
  }

  string = string.normalize('NFC');
  substring = substring.normalize('NFC');

  const sliceLen = substring.length;
  const strLen = string.length;
  for (let scan = 0; scan + sliceLen <= strLen; scan++) {
    const slice = string.slice(scan, scan + sliceLen);
    if (collator.compare(substring, slice) === 0) {
      return scan;
    }
  }

  return -1;
}, [collator]);

[snowystinger]

Thanks for the PR, you'll need to sign the CLA https://react-spectrum.adobe.com/contribute.html#contributor-license-agreement then you may need to close and reopen the PR to get it to take

[snowystinger]

This seems like a reasonable request.
Giving a provisional approval and will bring up with the rest of the team.

[reidbarber]

Discussed with the team and the one concern we have is that it doesn't match the existing pattern of the filter functions which is to return a boolean. Do you mind sharing the use case you ended up needing this for? We may need something like this in the future, so it may help us figure out where it could fit in.

[qmhc]

@reidbarber Perhaps this is a useSorting scenario.

In my case, there are some date and time options that need to be sorted by the first match position while being searched. The options that match earlier should be placed in front.