Skip to content

Docs - add sections and search filtering for community extensions #3260

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

Merged
merged 1 commit into from
Apr 8, 2025

Conversation

scrhartley
Copy link
Contributor

@scrhartley scrhartley commented Apr 2, 2025

Description

Try to make the community extensions docs table more approachable.

  • Add sections so that we can start to break up the big table.
  • Add search filtering to help finding appropriate extensions.

Current sections added: Data API, Integrations and Legacy.
Idea for additional section: We could put the Alpine and morphdom morphing extensions in a Morph section, but as there's just the two of them, I was on the fence about this, especially considering that currently the sections are at the end of the table.

WARNING - this doesn't include PR #3259 and will need updating due to the change from markdown to html an table.
Converted to a draft PR until that's been resolved.

Implementation details

  • Change table to use html to allow sections and section headers.
  • Add Zola shortcode to allow markdown in html
  • Upgrade hyperscript (to 0.9.14) so that the search functionality works

Checklist

  • I have read the contribution guidelines
  • I have targeted this PR against the correct branch (master for website changes, dev for
    source changes)
  • This is either a bugfix, a documentation update, or a new feature that has been explicitly
    approved via an issue
  • I ran the test suite locally (npm run test) and verified that it succeeded

@scrhartley scrhartley marked this pull request as draft April 2, 2025 16:22
@geoffrey-eisenbarth
Copy link
Contributor

I think this is an awesome addition. I think best practices would be to include a <search> landmark, have a <label>, and use [type=search] though:

<search>
  <label for="extension-filter">Search Extensions:</label>
  <input type="search" id="extension-filter" placeholder="Search Extensions...">
</search>

@scrhartley
Copy link
Contributor Author

scrhartley commented Apr 2, 2025

I think this is an awesome addition. I think best practices would be to include a <search> landmark, have a <label>, and use [type=search] though:

<search>
  <label for="extension-filter">Search Extensions:</label>
  <input type="search" id="extension-filter" placeholder="Search Extensions...">
</search>

For the main site search input the label text is hidden.
Should I do something similar? Otherwise the placeholder text seems redundant.

<label for="extension-filter" hidden>Search Extensions:</label>

@geoffrey-eisenbarth
Copy link
Contributor

Yeah, that sounds reasonable. I do know that labels are recommended by ARIA APG even if they are hidden. Typically a placeholder should not serve as a label and the contents of a placeholder are more for providing an example of what to fill in, but 🤷‍♂️

Also thanks for reminding me about the parent context: if the site search uses a <search> landmark (which it should), then they both need [aria-label] attributes. (I can't look at the full context right now bc babies, bedtimes, and mobile devices).

@Telroshan Telroshan added the documentation Improvements or additions to documentation label Apr 3, 2025
@Telroshan
Copy link
Collaborator

That's a very cool enhancement!
(#3259 has been merged btw)

@scrhartley scrhartley force-pushed the docs-community-extensions branch 2 times, most recently from 6a5249d to c1746b2 Compare April 3, 2025 15:11
@scrhartley scrhartley force-pushed the docs-community-extensions branch from c1746b2 to 4a131c2 Compare April 4, 2025 15:10
@scrhartley
Copy link
Contributor Author

Updated ARIA based upon: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/search_role
Marking as "Ready for review".

@scrhartley scrhartley marked this pull request as ready for review April 4, 2025 15:13
@scrhartley
Copy link
Contributor Author

Note:
This PR has the sections at the end and everything thing else is at the start without a section header.
It would be straight forward to add a General/Uncategorized/Misc header for the other extensions if we want to make a different choice about the order of things.

@Telroshan Telroshan requested a review from 1cg April 5, 2025 08:22
@1cg 1cg merged commit 6836e87 into bigskysoftware:master Apr 8, 2025
1 check passed
@1cg
Copy link
Contributor

1cg commented Apr 8, 2025

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants