Discourse Docs Card Filter Component

This theme component is to be used with the Discourse Docs Plugin.

It will allow you to place “Cards” that act as a clickable filter for quicker filter results upon entering the /docs page by your users.

The above would be rendered with these settings in the docs plugin:

Component Settings

You can select custom icons for each category or tag card filter. You can also allow category descriptions to be rendered in the category card filters.

19 Likes

Thanks for building this! Is it the case that if a user doesn’t have view permissions on a (private) category, the card for that private category won’t appear above the search box? (Or I suppose on the sidebar, but just want to confirm the behavior is consistent.)

1 Like

This should be the case as we are getting the category info from

@discourseComputed("category")
  categoryInfo(category) {
    return this.site.categories.findBy("id", category.id);
  },

To my knowledge, this.site.categories will only return those the current user can view.

2 Likes

Excellent. That will make it a real easy-to-use tool for people in our multiple workgroups who want quick access to their group(s) reference materials, and quickly filter our Group A from Group B, etc. Thanks!

3 Likes

Is it possible that the counter on /docs does not count topics moved into that category after it is already created?

I just made a new category, added in docs, moved a few topics but the counter still says “0 topic”.

EDIT: seems it just takes a while to update.

Is there a way to change the sort order for the cards, even if it requires modifying the code? I’d like for it to be Alphabetical rather than by topic count. Thanks!

Hi all. Docs and this extenstion of Docs are fantastic. Just one thing though. Can anyone assist me with somehow adding these cards to the top_menu or homepage sections? Would be awesome to have a standard homepage with ‘Latest’ by default, yet having these cards at the top. Then clicking on a card with take it to the filtered Docs page.

Also, I have another plugin (Search box) sitting in the top_menu section. I havent been able to figure out how to change order if multiple plugins are showing in this section.

Thanks.

1 Like

Hey @jordan.vidrine

We tried the tc and it works great for your use case. Now we can create a KB

In this context, I have a question: Can you suggest any workaround to add some parameters to each category or tag card? That way we would like to append &order=title in order to affect the sorting for each individual category or tag card.

PS:

Hmmm… Im not sure.

How would you like the sorting of the category & tag cards to appear?

Hey Jordan

We could add a sorting parameter in category icons theme setting. For the example, in case of the 6,heart, we can add an additional sorting command, e.g. to sort by topic title ascending, it would be 6,heart,title-asc.

When opening the category card, it would then just append the docs parameters such as: /docs?ascending=true&category=71&order=title

What do you think about that?

1 Like

While it’s possible this could work well on a site, without much feedback around this topic focusing on the ability to sort the cards, I dont necessarily feel the time spent on getting this to work properly is currently warranted.

That being said, we do encourage PRs on components, as well as forking a component to use in your own way!

Please feel free to make a PR with this functionality, or fork it to develop for yourself.

1 Like