paranext / paranext-core

Electron client, extension host, and C# library for Paranext
https://paranext.github.io/paranext-core/
MIT License
14 stars 3 forks source link

Allow Custom List Actions in Results List #469

Open katherinejensen00 opened 9 months ago

katherinejensen00 commented 9 months ago

Big Picture end goal: As an extension developer, I want to create a list item with custom actions so that users can have access to features that will help them fix found errors. For example, if I am creating a custom spell check, I might create a custom list item that has an autocorrect option in the right click context menu so a user could approve and apply an autocorrect.

Create a mapping of type to component for list items to know how to display a result from a given check. The results list would receive an array of results and each result would probably have a type so the list knows which component to use to display it.

ToDo for this task: Part 1: Display Scripture range from check results. Left clicking navigates to the text range. Right clicking opens the custom context menu. Allow checks to provide commands in the form of a small context menu definition (e.g. so that you can navigate directly to the relevant setting or inventory).

tjcouch-sil commented 3 months ago

It has been so long - do we remember if there was a particular need to show extension components in the results list?

We may want to consider only providing avenues through which extensions can give us commands to run from the right-click menu or something instead of dealing with the mess of letting them add components. Weigh pros and cons

katherinejensen00 commented 3 months ago

I think the thought was people might want to make their own checks and they would need to display their results somewhere. I think the thought with the components was they might want to have something clickable that could do an action like fix the problem or navigate to the problem. If we don't want to do that anymore, I am open.