0.0
No release in over 3 years
Low commit activity in last 3 years
dynamic_text allows you to easily integrate content-editable HTML divs for a specific attribute of a specific resource.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

~> 0.0.1
~> 5
 Project Readme

Welcome to Dynamic Text

Create a more seamless integration between displaying information and editing it! With Dynamic Text, you can allow users to easily update elements of a resource in your app just by clicking on the text and changing it, no separate edit page needed!

Build Status

Build Status

Installation

Add this line to your application's Gemfile:

gem 'dynamic_text'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dynamic_text

What does it do?

Dynamic Text allows you to do two main things:

1) Render editable content based on a resource and attribute

With the dynamic_text gem, you can easily create a hybrid HTML element that acts as both the display text for a specific attribute of a resource, and the text box for updating that attribute.

<%= editable_text_for(@article, :title) %>

2) Render dynamic content that updates in real time with editable text

You might not want all of the text for a specific attribute of a specific resource to be editable. For example, you might want to display the title for a blog post in both an 'h1' tag above the body of the post, as well as the navigation bar on the top of the screen.

In this case, you might want the text to be editable when pressed on in the main article section of the page, but not in the header. However, you probably still want the text in the header to change in real time if a user edits the title from within the article section.

You can use the following method to identify content that isn't editable but updates in real time when changes are made to the attribute of the resource somewhere else on the page.

<%= dynamic_text_for(@article, :title) %>

Why Does It Do It?

Long ago, in the Wild West of software, the key ingredient for a successful app was functionality. Every idea was unique back then, and the potential of apps and websites was virtually untapped.

Nowadays, almost everything has been done. In order to gain an edge on competitors, one of the best thing you can do is to look for ways to provide a better user experience.

I believe the days of pure CRUD apps in consumer facing applications are numbered, users no longer want to navigate through completely separate pages for specific actions on specific resources. Users want pages that provide information and actions for many different resources at once in an intuitive and easy-to-navigate manner (think 'dashboard' pages).

This gem is built as a way to merge the 'edit' page and the 'show' page for a given resource, so users can update content in real time just by clicking on the text that displays that information. For example, you could use this gem to merge the display text and edit field for the title of a blog post, so the H1 tag on the show page merges with the tag in the edit form, removing the necessity for a separate edit page to update that information.

License

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