Git Product home page Git Product logo

x-editable-rails's Introduction

X::Editable::Rails

X-editable for Rails

Installation

Add this line to your application's Gemfile:

gem 'x-editable-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install x-editable-rails

Usage

Insert files to your application

#= require editable/bootstrap-editable

You can choose between bootstrap-editable/jqueryui-editable/jquery-editable-poshytip

*= require editable/bootstrap-editable

You can choose between bootstrap-editable/jqueryui-editable/jquery-editable

You can also insert this file

#= require editable/rails

This is simple helper using CanCan

First you need to create simple helper, which returns true or false (if is editable enabled or not)

def xeditable?
  true # Or something like current_user.xeditable?
end

and this is how to use helper method

%h1= editable @page, 'name', e: @page.name
# editable object, what_you_want_update, e: exception - when is xeditable? false or can? :edit, object is false

or with nested attributes (globalize3 example)

%h1= editable @page, 'name', nested: 'translations', nid: @page.translation.id, e: @page.name
# nested: nested attributes, nid: id of nested attribute

Example of nested resource

%h1= editable [picture.gallery, picture], 'name', nested: 'translations', nid: picture.translation.id, e: picture.name

You can also update everything directly.

%a{href: '#', class: 'editable', data: { type: 'text', model: 'post', name: 'name', url: post_path(post), 'original-title' => 'Your info here'}}= post.name

or if nested

%a{href: '#', class: 'editable', data: { type: 'text', model: 'post', nested: 'translations', name: 'name', nid: "#{post.translation.id}", url: post_path(post), 'original-title' => 'Your info here'}}= post.name

You need to specify:

  1. data-model
  2. data-name
  3. data-url

When updating nested attributes also:

  1. data-nested
  2. data-nid

And don't forget to activate it

$('.editable').editable()

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

x-editable-rails's People

Contributors

jirikolarik avatar klaffenboeck avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.