Anchor ViewComponents

ViewComponents for Buoy’s Anchor Design System.

Dependencies

• Stimulus

Installation

1. Add anchor_view_components to your Gemfile and install:

   bundle add anchor_view_components && bundle install
   

2. Add @buoysoftware/anchor-view-components to your package.json and install:

   yarn add @buoysoftware/anchor-view-components && yarn
   

3. In config/application.rb, add the following statement:

   require "anchor/view_components/engine"
   

4. Add Anchor’s CSS to your application layout:

   <%= stylesheet_link_tag "anchor-view-components" %>
   

5. Import Anchor’s Stimulus controllers and register them:

   import { registerAnchorControllers } from "@buoysoftware/anchor-view-components";
   
   registerAnchorControllers(application);
   

6. Optionally, if you need Anchor’s Tailwind configuration to use its colors, fonts, and other design system values, add the following to your project’s tailwind.config.js:

   presets: [require("@buoysoftware/anchor-view-components/tailwind.config.js")]
   

Development

TODO

License

The gem is available as open source under the terms of the MIT License.