Premium DOM Component
Piqueme
Pique their interest
| Abstract |
|---|
|
The Piqueme DOM component is a just-in-time continuous feed of articles featuring collapsable/expandable UI cards. |
Background
Visitors appreciate the compact beauty of UI cards. They provide so much more than a simple hyperlink.
UI cards typically have some combination of these elements: image, headline and/or lede paragraph. UI cards give visitors the gist of hyperlinked articles without the effort — for visitors, there's no forward navigation to check out a new page; and there's no back navigation to continue where they left off.
UI cards keep visitors on the same page, and keep them reading your content.
The rwt-piqueme goes two steps further than the classic UI card: 1) it allows the visitor to read the entire article without ever leaving the original document, and 2) it saves network bandwidth by fetching articles only when needed.
The rwt-piqueme component has these features:
- Articles are initially displayed in UI card format with splash image, caption, kicker, headline, subhead, byline, dateline and lede.
- Visitors can choose to read the full article in situ, that is, without ever leaving the host page.
- UI cards can be toggled between collapsed and expanded states, to show just the UI card, or the full article.
- Articles are fetched just-in-time, when the visitor scrolls down to that part of the document.
- A document that contains a large set of potential UI cards will only fetch what's needed, and only when it's needed.
- Each component instance handles a single on-demand article.
In the wild
To see examples of this component in use, visit any of these sites, and be sure to look under-the-hood at the source code to see how easy it is to use the component.
| javascriptfanboi.com | JAVASCRIPT FANBOI |
| 2020stack.com | 2020 STACK |
| grok.readwritetools.com | READ WRITE GROK |
Installation
Prerequisites
The rwt-piqueme DOM component works in any browser that supports modern W3C standards. It has no other prerequisites. Distribution and installation are done with either NPM or via Github.
Download
Download using NPM
OPTION 1: Familiar with Node.js and the package.json file?
Great. Install the component with this command:
npm install rwt-piqueme OPTION 2: No prior experience using NPM?
Just follow these general steps:
- Install Node.js/NPM on your development computer.
- Create a
package.jsonfile in the root of your web project using the command:
npm init
npm install rwt-piqueme Important note: This DOM component uses Node.js and NPM and package.json as a convenient distribution and installation mechanism. The DOM component itself does not need them.
Download using Github
If you prefer using Github directly, simply follow these steps:
- Create a
node_modulesdirectory in the root of your web project. - Clone the rwt-piqueme DOM component into it using the command:
git clone https://github.com/readwritetools/rwt-piqueme.git Using the component
After installation, you should add two things to your HTML page to make use of it:
- Add a
scripttag to load the component'srwt-piqueme.jsfile:
<script src='/node_modules/rwt-piqueme/rwt-piqueme.js' type=module></script> - Add articles to the page one by one, identifying their location with the
component's
sourcerefattribute:
<rwt-piqueme sourceref='/2021/Jan/article01.html'></rwt-piqueme>
<rwt-piqueme sourceref='/2021/Feb/article02.html'></rwt-piqueme>
<rwt-piqueme sourceref='/2021/Mar/article03.html'></rwt-piqueme>
<rwt-piqueme sourceref='/2021/Apr/article04.html'></rwt-piqueme>Article meta data
The UI card properties that the visitor sees are extracted in real-time from
each article. They are pulled from <meta> tags placed in each article's <head>.
You should configure your web server to add the following meta tags:
picueme:photo- The URL to a picture to splash across the top of the UI card.
piqueme:caption- A one line description of the splash picture.
piqueme:kicker- A word or short phrase placed above the headline.
piqueme:headline- The article's title.
piqueme:subhead- The article's subtitle.
piqueme:byline- The author of the article.
piqueme:dateline- The date the article was published.
piqueme:lede- The first paragraph of the article.
piqueme:textblock- An HTML DOM selector referencing the
<div>that contains the text of the article.
All <meta> tags are optional. Configure only the ones that you want displayed in
the UI card.
Note that all URL's are subject to the browser's same-origin security policy. If articles or images are coming from a different server, you must ask that server's administrator to configure CORS permissions for your origin server.
UI card layout and styling
The HTML layout for the UI card is configured in the component's rwt-piqueme.blue
file. Only advanced applications will need to change this.
The default CSS styling uses a dark mode theme. It is configured in the rwt-piqueme.css
file. You can replace the contents of this file with CSS that matches your
website's typeface and color theme.
Life-cycle events
The component issues life-cycle events. These can be used in advanced applications to trigger other actions.
component-loaded- Sent when the component is fully loaded and ready to be used.
fetch-complete- Sent when an article has been fetched over the network. The event's
detailproperty will contain two values:remoteURLandfetchStatus.
Reference
 | Documentation | READ WRITE HUB |
 | Source code | github |
 | Component catalog | DOM COMPONENTS |
 | Package installation | npm |
 | Publication venue | READ WRITE STACK |
License
The rwt-piqueme DOM component is not freeware. After evaluating it and before using it in a public-facing website, eBook, mobile app, or desktop application, you must obtain a license from Read Write Tools .
Piqueme Software License Agreement
- This Software License Agreement ("Agreement") is a legal contract between you and Read Write Tools ("RWT"). The "Materials" subject to this Agreement include the "Piqueme" software and associated documentation.
- By using these Materials, you agree to abide by the terms and conditions of this Agreement.
- The Materials are protected by United States copyright law, and international treaties on intellectual property rights. The Materials are licensed, not sold to you, and can only be used in accordance with the terms of this Agreement. RWT is and remains the owner of all titles, rights and interests in the Materials, and RWT reserves all rights not specifically granted under this Agreement.
- Subject to the terms of this Agreement, RWT hereby grants to you a limited, non-exclusive license to use the Materials subject to the following conditions:
- You may not distribute, publish, sub-license, sell, rent, or lease the Materials.
- You may not decompile or reverse engineer any source code included in the software.
- You may not modify or extend any source code included in the software.
- Your license to use the software is limited to the purpose for which it was originally intended, and does not include permission to extract, link to, or use parts on a separate basis.
- An eBook published under a single title and author.
- A mobile app for distribution under a single app name.
- A desktop application published under a single application name.
- A website published under a single domain name. For this purpose, and by way of example, the domain names "alpha.example.com" and "beta.example.com" are considered to be separate websites.
- A load-balanced collection of web servers, used to provide access to a single website under a single domain name.
Activation
To activate your license, copy the rwt-registration-keys.js file to the root
directory of your website, providing the customer-number and access-key sent to
your email address, and replacing example.com with your website's hostname.
Follow this example:
export default [{
"product-key": "rwt-piqueme",
"registration": "example.com",
"customer-number": "CN-xxx-yyyyy",
"access-key": "AK-xxx-yyyyy"
}]