Sha256: 6a31896f6810191ce9d5eda5eebd7efab901ab0e5c862a3f159ab1f7c747e06c

Contents?: true

Size: 1.87 KB

Versions: 1

Compression:

Stored size: 1.87 KB

Contents

Edifice
=======

Edifice.js is a rails gem for integrating your JS + CSS more closely with your Rails 3 workflow. There are two closely related gems--[edifice-forms](/tmeasday/edifice-forms) and [edifice-widgets](/tmeasday/edifice-widgets)--which do not rely on, but complement it well.

Installation
------------

To install, simply add to your Gemfile:

```ruby
gem 'edifice'
```

Page Specific CSS
-----------------

Add this to your body tag:

```html
<body class="<%= edifice_body_classes %>">
```

And you are now free to namespace your CSS like so:

```css
.c_users.v_show h1 {
  background-color: red;
}
```

Of course this namespacing works best with a CSS-preprocessor like [SCSS](http://sass-lang.com/):

```scss
.c_users.v_show {
  h1 {
    background-color: red;
  }
  p {
    margin-bottom: 20px;
  }
}
```

The `c_` part will be set to the path of, and the `v_` part to the name of the view that has been rendered by rails. We also set `l_NAME` to the name of the layout rendered, so you can write layout specific CSS with ease.

Page Specific Javascript
------------------------

For a simple way to write page specific javascript, include edifice in your `application.js`:

```js
/*
 *= require edifice
 */
```

Include the edifice meta tags in your header:

```erb
<head>
  <%= edifice_meta_tags %>
</head>
```

Edifice expects you to create a simple JS object that will be called when you page loads (either directly or via AJAX/[PJAX](https://github.com/defunkt/jquery-pjax)), like so:

```js
window.usersShow = {
  onReady = function() {
    alert("The users#show page has reached the DomContentLoaded state");
  }
}
```

Alternatively you could define `onLoad` (which fires on `window.load`), or nothing at all, if you like. We're easy.


License
-------

Edifice is crafted by [Percolate Studio](http://percolatestudio.com) and released under the [MIT license](www.opensource.org/licenses/MIT)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
edifice-1.1.1 README.md