RapidRails UI Documentation :: RapidRails UI Book

Welcome 👋🏼

This is the documentation for the RapidRails UI Components kit. It is a collection of UI components that can be used in any Rails application. The components are built using Tailwind CSS, a utility-first CSS framework for rapidly building custom user interfaces, and ViewComponent, a library for building reusable & encapsulated view components in Ruby on Rails.

Overview 📖

This is kind of a long-form documentation to live alongside RapidRails UI Component previews. The goal is to provide a place to document components, blocks and templates and their usage. This is a work in progress and will be updated as the project progresses.

Getting Started 🚀

Check the left sidebar OR the previews section for a list of components. Click on a component to see its documentation. Each component page will have a preview of the component and its usage.

Contributing 🤝🏼

Suggestions for new features or report issues are welcome. Feel free to email me at ahmed@rapidrails.cc.

Lookbook v2.1.1

{ "version": "2.1.1", "env": "production", "config": { "project_name": "RapidRails UI Book", "project_logo": false, "preview_collection_label": "Components", "preview_paths": [ "test/components/previews", "/app/test/components/previews", "/app/test/components/previews" ], "preview_display_options": { }, "preview_controller": "ViewComponentsController", "preview_template": "lookbook/previews/preview", "preview_inspector": { "main_panels": [ "preview", "output" ], "drawer_panels": [ "source", "notes", "params", "*" ] }, "preview_embeds": { "enabled": true, "policy": "ALLOWALL", "panels": false, "actions": [ ], "scenarios": [ ], "display_option_controls": true }, "preview_layout": "component_preview", "preview_disable_action_view_annotations": true, "preview_type_default": "view_component", "preview_sort_scenarios": false, "page_collection_label": "UIBook", "page_controller": "Lookbook::PageController", "page_route": "pages", "page_paths": [ "/app/test/components/docs" ], "page_extensions": [ "html.*", "md.*" ], "page_options": { }, "markdown_options": { "tables": true, "fenced_code_blocks": true, "disable_indented_code_blocks": true, "strikethrough": true, "highlight": true, "with_toc_data": true, "lax_spacing": true }, "highlighter_options": { "theme": "github", "dark": false }, "component_paths": [ "app/views", "app/components", "app/components" ], "reload_on_change": false, "live_updates": false, "listen_paths": [ ], "listen_extensions": [ "rb", "html.*" ], "autoload_previews": true, "ui_theme": "rose", "ui_theme_overrides": { "header_bg": "#be123c", "nav_icon_stroke": "red" }, "ui_favicon": true, "log_level": 2, "log_use_rails_logger": true, "debug_menu": true, "links": { "docs": "https://v2.lookbook.build", "demo": "https://v2-demo.lookbook.build", "repo": "https://github.com/ViewComponent/lookbook/tree/v2" }, "using_view_component": true, "dependencies": { "actioncable": true, "listen": false, "view_component": true }, "panels": { }, "inputs": { }, "tags": { } } }