Midwest Component Library v0.28.2

Previews

No matching results.

Install in your Rails project

Requirements

  • Ruby >= 3.4
  • Rails >= 7.1
  • ViewComponent >= 3.20.0 (installed automatically as a dependency)

Installation

Add to Gemfile:

gem "midwest", github: "unabridged/midwest", branch: "main"

Run installer:

bin/rails midwest:install

The installer handles the following automatically:

  • Adds the Midwest stylesheet to your application layout
  • Adds midwest_body_styles to your <body> tag for CSS custom property support
  • Pins midwest-view-components via importmap (or adds it via yarn for esbuild/webpack setups)
  • Includes Midwest::ViewHelper and Midwest::UrlHelper in ApplicationHelper
  • Registers Midwest Stimulus controllers

Configuring the design system

Set application-wide design defaults from an initializer. Because midwest_body_styles renders these onto your <body> as CSS custom properties, they cascade over the values shipped in the stylesheet for the whole page — while any per-call component option still wins locally.

# config/initializers/midwest.rb
Midwest.configure do |config|
  # Motion "design feel" — keywords resolve to design tokens, or pass raw CSS.
  config.motion.duration = :slow        # => var(--duration-slow)
  config.motion.distance = :xl          # => var(--space-2xl)
  config.motion.easing   = :emphasized  # => var(--ease-emphasized)
  config.motion.scale    = 0.9          # raw values pass through
end

The same Midwest.configure block works in a Bridgetown app (place it in config/initializers.rb).

Development

To get started contributing to the library:

  1. Run: bundle install
  2. Run: yarn install
  3. Run: bin/dev

This opens the demo app with component previews at localhost:4000. Component previews are in demo/app/previews.

To run tests:

bin/test                  # all appraisals on the current Ruby version
bin/test --all            # full matrix: Ruby 3.3, 3.4, 4.0 × Rails 7 & 8
bin/test --rails 8        # Rails 8 only, current Ruby
bin/test --rails 8 --ruby 4.0  # Rails 8 on Ruby 4.0 only

To generate new components:

bin/rails midwest:generate:component YourComponent