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

Document how to use the plugin without its JS assets #287

Open
seanaery opened this issue Nov 21, 2024 · 2 comments
Open

Document how to use the plugin without its JS assets #287

seanaery opened this issue Nov 21, 2024 · 2 comments

Comments

@seanaery
Copy link
Collaborator

Some implementers may wish to use this plugin in a bare-bones minimal fashion without having to sweat the overhead of its Javascript dependencies. It'd be useful to document clearly how to do that, probably in the README. Semi-dependent on #286 .

For instance, using this configuration range_config: { chart_js: false, textual_facets: false } with no JS at all will still get you the most essential features of the plugin.
Screenshot 2024-11-20 at 12 44 37 PM
Screenshot 2024-11-20 at 12 44 55 PM

Possible Scenarios

  • You really just want a minimalist UI that lets a user enter a begin/end, apply the limit, and show what limit is applied.
  • Your application still uses Sprockets for JS and adding support for import maps or JS bundling tooling isn't yet practical.
  • An issue (security? accessibility?) arises with chart.js that isn't easily/quickly fixable; implementers have flexibility to keep using the plugin without the bells & whistles.
  • Similarly, an incompatibility arises with a future version of Blacklight, Rails, or another dependency, and implementers have flexibility.

Related Work:

@jrochkind
Copy link
Member

jrochkind commented Nov 21, 2024

Are we sure this isn't already in BL core?

My understanding was that it was, although I don't know the details. I wonder if we could find anyone who does to answer? I want to make sure we aren't recommending people install and use this plugin for something they could do in BL core without this plugin.

Like probably at least 80% of the code in here is about being able to deliver range buckets, there's a lot of complexity here if you aren't using that! Whether graphically or textually or both.

@seanaery
Copy link
Collaborator Author

Oh good point, that'd be great to confirm. I assumed this kind of simple range facet is not supported by core Blacklight alone. If it is, it's not documented well (if at all). If there's support and documentation for it in core, I think it'd be helpful to add a heads-up note about it in the blacklight_range_limit README.

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

No branches or pull requests

2 participants