bootstrap5-rails-extensions-js
v0.2.0
Published
Stimulus controllers for bootstrap5-rails-extensions
Maintainers
Readme
bootstrap5-rails-extensions-js
Bootstrap 5とStimulusでモーダル・オフキャンバス・トーストを制御するためのコントローラー群です。Rails Engine版(bootstrap5-rails-extensions)に含まれるJavaScriptを独立パッケージ化しています。
インストール
npm install bootstrap5-rails-extensions-js
# または
yarn add bootstrap5-rails-extensions-js本パッケージは @hotwired/stimulus と bootstrap をピア依存関係として利用します。未導入の場合は合わせて追加してください。
使い方
Stimulusアプリケーションへ必要なコントローラーを直接登録してください。
// app/javascript/controllers/index.js
import { application } from "./application"
import {
ModalController,
OffcanvasController,
ToastController,
} from "bootstrap5-rails-extensions-js"
application.register("modal", ModalController)
application.register("offcanvas", OffcanvasController)
application.register("toast", ToastController)必要に応じて上記の登録対象を絞り込んだり、独自のコントローラーに差し替えてご利用ください。
補足
- コントローラーはES Modules形式で提供しています。バンドラの設定により必要に応じてトランスパイルしてください。
- ライセンスはMITです。詳細はGemプロジェクト側のライセンスに従います。
