Rails UI Stimulus.js Components

A suite of Stimulus.js components built with Tailwind CSS for use in Rails UI. You can use these independently of Rails UI.

View demo

Pre-requsities

You'll need to install and configure Stimulus.js in your project before using this package.

Installation

Add the module railsui-stimulus

npm install railsui-stimulus

Import it in your main entrypoint file.

// Start Stimulus
import { Application } from '@hotwired/stimulus'

const application = Application.start()

// Import components adhoc.
import {
  RailsuiClipboard,
  RailsuiCountUp,
  RailsuiDateRangePicker,
  RailsuiDropdown,
  RailsuiModal,
  RailsuiSelectAll,
  RailsuiTabs,
  RailsuiToast,
  RailsuiToggle,
  RailsuiTooltip,
} from 'railsui-stimulus'

application.register('railsui-clipboard', RailsuiClipboard)
application.register('railsui-count-up', RailsuiCountUp)
application.register('railsui-date-range-picker', RailsuiDateRangePicker)
application.register('railsui-dropdown', RailsuiDropdown)
application.register('railsui-modal', RailsuiModal)
application.register('railsui-select-all', RailsuiSelectAll)
application.register('railsui-tabs', RailsuiTabs)
application.register('railsui-toast', RailsuiToast)
application.register('railsui-toggle', RailsuiToggle)
application.register('railsui-tooltip', RailsuiTooltip)

Components

• Clipboard
• Count up
• Date range picker
• Dropdown
• Modal
• Select all
• Tab
• Toast
• Toggle
• Tooltip

Styles

The examples provided come from some of the UI from Rails UI. You'll want to tweak this to match your needs, or go check out Rails UI for drop-in UI for your next Ruby on Rails application.

Extending

With Stimulus, you can inherit one component from another. Inherited controllers automatically access the targets defined by their parent class.

If you override the connect, disconnect, or any other methods from the parent, call super.method() so the parent’s functionality is properly executed.

import { RailsuiToggle } from 'railsui-stimulus'

export default class CheckboxToggle extends RailsuiToggle {
  connect() {
    super.connect()
    console.log('toggleable', this.toggleableTarget)
  }
}

Bugs/Contributing

Run npx serve locally to preview all components.

Bug reports and pull requests are welcome! Head to https://github.com/getrailsui/railsui-stimulus.

Build Ruby on Rails apps faster than ever

Rails UI gives Rails developers instance access to professionally designed templates and components.

Leverage breathtaking UI to fast-track your next idea.