@solrengine/ui

Stimulus controllers for solrengine-ui ViewComponents.

Installation

npm install @solrengine/ui

Setup

Register all controllers at once:

import { Application } from "@hotwired/stimulus"
import { registerControllers } from "@solrengine/ui"

const application = Application.start()
registerControllers(application)

Or register individually:

import { Application } from "@hotwired/stimulus"
import { ModalController, ThemeController } from "@solrengine/ui"

const application = Application.start()
application.register("sui-modal", ModalController)
application.register("sui-theme", ThemeController)

Controllers

| Controller | Identifier | Purpose | |-----------|-----------|---------| | ModalController | sui-modal | Open/close modals, ESC key, backdrop click | | DropdownController | sui-dropdown | Toggle menus, click-outside close | | ClipboardController | sui-clipboard | Copy text + "Copied!" feedback | | ThemeController | sui-theme | Dark/light toggle, localStorage persistence | | NotificationController | sui-notification | Auto-dismiss toast notifications |

Usage with solrengine-ui gem

This package provides the JavaScript interactivity for the solrengine-ui Ruby gem. Install both:

# Gemfile
gem "solrengine-ui"

npm install @solrengine/ui

Then run the install generator:

bin/rails generate solrengine:ui:install

License

MIT