Skip to content

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

@seanaery

Description

@seanaery

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:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions