Jonas Hübotter

Apps Open Source Contact

Mozaic

An opinionated layout engine for Rails

Mozaic

Gem Version

Mozaic is an opinionated layout engine for Rails. It simplifies handling numerous layouts and components.


Table of Contents


Installation

Mozaic works with Rails 5 onwards. You can add it to your Gemfile with:

gem 'mozaic'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mozaic

If you always want to be up to date fetch the latest from GitHub in your Gemfile:

gem 'mozaic', github: 'jonhue/mozaic'

Now run the generator:

$ rails g mozaic:install

Usage

Layouts

You can run a generator to create new layouts

$ rails g mozaic:layout -n my/new/layout

Note: Pass the -e option to extend another layout with this new layout.

You can use the mozaic helper to extend other layouts:

= mozaic :layout do
    ...

mozaic takes the layout you want to extend as a first and the area where content should be rendered as a second parameter. Both of them default to :mozaic.

Here is how you specify areas to extend layouts:

= mozaic_area :area do
    ...

Note: Make sure that your area names are unique across all layouts.

Components

Mozaic allows you to define components to organize your code:

$ rails g mozaic:component -n name
Mozaic.configure do |config|
    config.define_component :name
end

You are also able to pass default options to your components:

Mozaic.configure do |config|
    config.define_component :name, lovely: true
end
= options[:lovely].to_s

You can run custom code whenever your component gets rendered:

Mozaic.configure do |config|
    config.define_component :name, lovely: true do |options|
        options[:lovely] = !options[:lovely]
        options
    end
end

Return false in the block to return nil instead of rendering the component:

Mozaic.configure do |config|
    config.define_component :name, lovely: true do |options|
        false unless options[:lovely] == true
    end
end

Components can also be defined in your ActiveRecord classes:

class User < ApplicationRecord
    define_component :avatar
end

Rendering components is fairly straight forward:

= component :name

You are able to override the default options:

= component :name, lovely: false

And to pass a block:

= component :name, lovely: false do
    It is lovely.

Here is how to access a block in your component:

= options[:lovely].to_s
= block

Assets

Webpack (ES6)

The component generator generates asset files in your configured directories.

The JavaScript assets use ES6 by default. You can now import a component:

import ComponentName from 'mozaic/component/name';
let componentName = new ComponentName(document.querySelector('.mozaic-component.document-name'));

Sprockets

With Mozaic you can automatically add assets to the asset pipeline by naming them like the component they belong to. Just require Mozaic in your application assets:

//= require_tree ./mozaic
/*
 *= require_tree ./mozaic
 */

For instance a component with the name 'my/test/component' can have a javascript asset located at app/assets/javascripts/mozaic/my/test/component.js and a stylesheet under app/assets/stylesheets/mozaic/my/test/component.css.

Note: Asset files are being created automatically when using the component generator.


Configuration

You can configure Mozaic by passing a block to configure. This can be done in config/initializers/mozaic.rb:

Mozaic.configure do |config|
    config.define_component :name
end
  • define_component Define components
  • es6 Whether generated JavaScript assets for components should use ES6 syntax or not. Accepts a boolean. Defaults to true.
  • javascripts Directory to place JavaScript assets for components in. Accepts a string. Defaults to 'app/javascript/javascripts'.
  • stylesheets Directory to place styleshets for components in. Accepts a string. Defaults to 'app/javascript/stylesheets'.

To Do

Here is the full list of current projects.

To propose your ideas, initiate the discussion by adding a new issue.


Contributing

We hope that you will consider contributing to Mozaic. Please read this short overview for some information about how to get started:

Learn more about contributing to this repository, Code of Conduct

Contributors

Give the people some ❤️ who are working on this project. See them all at:

https://github.com/jonhue/mozaic/graphs/contributors

Semantic Versioning

Mozaic follows Semantic Versioning 2.0 as defined at http://semver.org.

License

MIT License

Copyright (c) 2018 Jonas Hübotter

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Ruby

1 ⭐️

Updated 3 months ago