coupdoeil 1.0.0.pre.beta.1 → 1.0.0.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0fd9529e23fb3e0e07534e4a893267f34f1759ad0da9f66c28f3e06598d8064
-  data.tar.gz: 921bbe9b79fd87200f309b6e3ec7ed2650871bc66943cffdf4b6c726bf2e7de0
+  metadata.gz: ed6dba2c7479bf3bc8c8bc7a7dc64ff2337e48bfcc73f1676155b299397abfa7
+  data.tar.gz: 517aedf83960f882ded74e7c1ff9af8aa8fcf965c5a708ea764b1fb481af8752
 SHA512:
-  metadata.gz: df7d9f69c35d3ec782694c8cad41d16714542d252883576e7c65551e451d9cdc382c5bc4c2c02fbe322c4d0c721e65a595e4b8b65cf43655fa41beecb115ae82
-  data.tar.gz: 2cc87dbc76fd8579845913cd230409071c902bd8f4a3b91caff504ab6bb0c066b17f77caebe2f99c4a6ed5a0a956918a7023595e4b24cbb671741eb8698b708b
+  metadata.gz: 0dcbb4dffc044a7b211ab4e34b0b174ed4a1af787f9838ec16de7c5295c359f0646e161d0562c2bd7971cac655edbaaefac98b184b3dd0a62e6474052351e158
+  data.tar.gz: abed2844c081804342c98eddb10898bf74a1f2c8341c232c809c04474e91bc5577b8f48ece9be506309eaa8f2cf75c7472ba8dcb0e51e9881c646f3d8fec8755

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+### v1.0.0-beta.2
+- change hovercard naming for popover
+
 ### v1.0.0-beta.1
 - fix path helpers in hovercard templates
 - fix call to clearHovercard in closing.js

data/README.md

@@ -1,35 +1,35 @@
 # Coupdoeil
 [![Gem Version](https://badge.fury.io/rb/coupdoeil.svg?icon=si%3Arubygems&icon_color=%23ff2600)](https://badge.fury.io/rb/coupdoeil)
 
-A framework to easily handle hovercards.
+A framework to easily handle popovers.
 
 ## Documentation
 See [coupdoeil.org](https://coupdoeil.org) for full documentation.
 
 ## Overview
 
-### What is a Coupdoeil::Hovercard?
+### What is a Coupdoeil::Popover?
 
-Hovercards are ruby objects used to easily build powerful popups (from basic tooltips to full dialog hovercards).
-They are mostly inspired by GitHub hovercards (like hovering on a link to a repo, or a username)
+Popovers are ruby objects used to easily build powerful popups (from basic tooltips to full dialog popovers).
+They are mostly inspired by GitHub popovers (like hovering on a link to a repo, or a username)
 and Wikipedia popups (when hovering a link to another wikipedia article).
 
 Click to toggle examples
 <details>
     <summary><i>A quick look on a contact details</i></summary>
-    <img src="https://coupdoeil.org/overview-example.gif" alt="hovercard example" />
+    <img src="https://coupdoeil.org/overview-example.gif" alt="popover example" />
 </details>
 <details>
     <summary><i>A form in a popup</i></summary>
-    <img src="https://coupdoeil.org/overview-example-2.gif" alt="hovercard example" />
+    <img src="https://coupdoeil.org/overview-example-2.gif" alt="popover example" />
 </details>
 [See more use-cases](https://coupdoeil.org/case-studies.html)
 
 The current implementation takes inspiration from both ViewComponent and ActionMailer, to make it as easy as possible to use while offering a wide range of possibilities.
 
 ```ruby
-# app/hovercards/contact_hovercard.rb
-class ContactHovercard < Coupdoeil::Hovercard
+# app/popovers/contact_popover.rb
+class ContactPopover < Coupdoeil::Popover
   def details
     @contact = params[:contact]
   end
@@ -37,7 +37,7 @@ end
 ```
 
 ```erb
-<%# app/hovercards/contact_hovercard/details.html.erb %>
+<%# app/popovers/contact_popover/details.html.erb %>
 <div class="contact-details">
   <%= image_tag @contact.avatar %>
   <strong><%= @contact.first_name %> <%= @contact.last_name %></strong>
@@ -51,40 +51,40 @@ Which is embedded by doing so:
 <%# app/views/messages/show.html.erb %>
 <div>
     <span>From: </span>
-    <%= coupdoeil_hovercard_tag ContactHovercard.with(contact: @contact).details do %>
+    <%= coupdoeil_popover_tag ContactPopover.with(contact: @contact).details do %>
       <span class="contact-pill"><%= @contact.email %></span>
     <% end %>
 </div>
 ```
 
-### Why use Coupdoeil hovercards?
+### Why use Coupdoeil popovers?
 
-The concept of 'quick look' allowed by hovercards can really improve UX by avoiding the need to navigate to another page and back again just to check summary for a resource.
+The concept of 'quick look' allowed by popovers can really improve UX by avoiding the need to navigate to another page and back again just to check summary for a resource.
 It also permits to hiding until use some parts of UI like small forms, or quick actions in a list of elements.
 
-The most common examples of such hovercard are on GitHub (when hovering over a link to a repo, user profile, a PR, etc.) or on
+The most common examples of such popover are on GitHub (when hovering over a link to a repo, user profile, a PR, etc.) or on
 Wikipedia (when hovering over a link to another article).
 
 While basic popups implementations can be made with simple helpers, data-attributes, and a bit of JavaScript,
 it tends to get too complex over time and often not handle enough edge-cases to be used everywhere it could improve UX.
 
-`Coupdoeil::Hovercard` offers a way to easily encapsulate and power up hovercards rendering logic.
+`Coupdoeil::Popover` offers a way to easily encapsulate and power up popovers rendering logic.
 It allows a lot of customization possibilities (see [options](https://coupdoeil.org/opts.html)) and promotes re-usability by using an API similar to
 parameterized ActionMailer (see [Why does it look like a mailer?](https://coupdoeil.org/architectural-decisions.html#why-does-it-look-like-a-mailer)).
 
-This gem also tries to handle all known issues of such hovercards, such as
-the user's mouse quickly leaving and re-entering hovercard without closing it,
-preventing opening of an hovercard if mouse did not stop on it, etc.
+This gem also tries to handle all known issues of such popovers, such as
+the user's mouse quickly leaving and re-entering popover without closing it,
+preventing opening of an popover if mouse did not stop on it, etc.
 
 ### Performances
 
-By default, an hovercard content is not loaded until it is needed.
+By default, an popover content is not loaded until it is needed.
 It means the DOM is not cluttered with 'maybe to be used' HTML, hidden in template tags or data-attributes.
-However, params have to be present in HTML so they are sent for rendering the hovercard (eg: a record id),
+However, params have to be present in HTML so they are sent for rendering the popover (eg: a record id),
 so try passing as few as required to build it later during render.
-Also, hovercards are cached so the fetch happens only the first time an hovercard is open.
+Also, popovers are cached so the fetch happens only the first time an popover is open.
 
-When needed, hovercards can still be preloaded and included in DOM on initial page load. See [preload option](https://coupdoeil.org/options/loading.html).
+When needed, popovers can still be preloaded and included in DOM on initial page load. See [preload option](https://coupdoeil.org/options/loading.html).
 
 ## Licence 
 Coupdoeil is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT)