Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add filter to table #52

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dr0i
Copy link
Member

@dr0i dr0i commented Oct 28, 2024

Proof of concept - WIP

Question is: is this HTML table useful?
from metafacture/metafacture-core#369:

Add filtering support in flux-commands.md, e.g. generate filter 'buttons' for each type as input and output, e.g. ->StreamReceiver for all decoders, StreamReceiver-> for all encoders, etc.

Would this HTML table provide the needed functionality?

@dr0i
Copy link
Member Author

dr0i commented Oct 28, 2024

Provides a sortable HTML table.

To test: checkout the branch and point your browser's URL to:
file:///$yourHomePath/$repoPath/metafacture-documentation/docs/flux/flux-commands-table.html

@dr0i dr0i self-assigned this Oct 28, 2024
@dr0i
Copy link
Member Author

dr0i commented Oct 29, 2024

Would this simple HTML table provide the needed functionality?

Thinking about it - no. We indeed need filter.

@dr0i dr0i changed the title Add sortable HTML table Add filter to table Oct 29, 2024
The flux-commands-table.html is a HTML view of flux-commands.md with
filter and sort functionality of the signature of the commands.

Proof of concept - WIP
@dr0i dr0i force-pushed the metafacture-core-369-addFluxCOmmandsAsSortableTable branch from 60f5cd1 to 70e9743 Compare October 29, 2024 16:03
@dr0i dr0i marked this pull request as draft October 29, 2024 16:04
@dr0i
Copy link
Member Author

dr0i commented Oct 29, 2024

The HTML table comes now with filter for the signature. The name column is sortable.
To test proceed as described in #52 (comment) .

@TobiasNx
Copy link
Collaborator

TobiasNx commented Nov 4, 2024

I thinik this table is cool, but I do not know If we should duplicate the documentation. Also the page should be implemented into the just-the-docs template. Perhaps we should only add the name of the function linking to the documentation and the sig in and sog out column.

@dr0i
Copy link
Member Author

dr0i commented Nov 4, 2024

Discussed with @maipet and @TobiasNx we should try to integrate the table into our documentation, at best instead of https://metafacture.github.io/metafacture-documentation/docs/flux/flux-commands.html. What's missing:

  • freeze table header when scrolling
  • anchor links
  • jekyl searchable, including the level view ("search-context")
  • formatting in description and options

Copy link
Member

@blackwinter blackwinter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the functionality, although I would prefer to be able to filter the other columns as well (especially the command column); I've had good success with jQuery Tablesorter.

Maybe you want to reference your source?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Review
Development

Successfully merging this pull request may close these issues.

4 participants