Skip to main content

Introduction

The name candlestick comes from the times when the telephone had just been invented. One of the first models of a telephone was a stick which was placed on a table where the speaker could talk into it.

docs/candlestick.jpg

This module provides a javascript library to automatically generate phone links. A treeWalker walks through the whole DOM and collects all textNodes. If a node matches a phone number the number will be replaced with a <a href="tel:phonenumber">Your phonenumber</a> link. Existing links or input fields are not affected.

By default the candlestick.integration.js is loaded which converts all phone numbers in the body.

Compatibility

Plone 4.3.x Plone 5.1.x

Installation

  • Add the package to your buildout configuration:

[instance]
eggs +=
    ...
    ftw.candlestick

Development

Python:

  1. Fork this repo

  2. Clone your fork

  3. Shell: ln -s development.cfg buidlout.cfg

  4. Shell: python boostrap.py

  5. Shell: bin/buildout

Or start an instance by running bin/instance fg.

Client library

Getting Started

The client library depends on Grunt. Assuming you already have Node.js installed on your system, run the following command:

sudo npm install -g grunt

To install the dependencies, run the following command:

npm install

And with npm you get the following packages:

  • Grunt - JavaScript task runner.

  • Babel - ES6 Transpiler.

  • Browserify - Dependency Bundler

  • Karma - JavaScript test runner.

  • Jasmine - JavaScript test suite.

  • Chai - JavaScript Assertion Library.

Usage

Run the following command to re-build the library:

grunt build

Run the following command to watch for changes which trigger a rebuild:

grunt

Build options

See https://github.com/substack/browserify-handbook for more information about browserify.

Source Maps

Browserify comes with a built-in support to generate source maps. It is already enabled by default, but feel free to disable source maps. Refer to this article to enable source maps in Google Chrome, if you haven’t already done so.

Tests

Run all tests

grunt test

Run a specific test

grunt test --grep="Name of your test"

Initialization

Converts all phone numbers to links

window.candlestick();

Changelog

1.1.5 (2020-10-26)

  • Pin down setuptools for Python 2.7 compatibility reasons. [busykoala]

  • Make parsing phone number rebust, so it does not break the whole site if merged with other resources. [mathias.leimgruber]

  • Add support for 0800 numbers. [mathias.leimgruber]

1.1.4 (2019-12-17)

  • Combine yarn watch and grunt watch [Nachtalb]

  • Fix candlestick being run to early before DOM is ready [Nachtalb]

1.1.3 (2019-12-14)

  • Fix plone 5 resource bundle for production mode. [tinagerber]

1.1.1 (2019-09-23)

  • Add profile (and uninstall profile) for Plone 5. [djowett-ftw]

  • Update README.rst to improve English and note Plone5.1 compatibility. [djowett-ftw]

1.1.0 (2019-09-04)

  • Test against Plone 5.1.x. [mbaechtold]

  • Add HISTORY.txt to long description. [busykoala]

1.0.5 (2018-01-11)

  • Compile javascript sources. [Kevin Bieri]

1.0.4 (2017-12-13)

  • IBAN number are no longer recognized as phone numbers. [Kevin Bieri]

1.0.3 (2017-03-23)

  • Fix parson of phonenumbers.

    • No longer allow too short phonenumbers

    • Allow phone numbers with varying spaces around number groups

    [Kevin Bieri]

  • Move phonenumbers samples to testing section. [Kevin Bieri]

  • Fix readme. [Kevin Bieri]

1.0.2 (2017-03-10)

  • Fix parse and replace issues.

    • Parentheses should not be included in the phone links.

    • Trailing text should not be ignored.

    [Kevin Bieri]

1.0.1 (2017-01-13)

  • Fix error in treeWalker on Internet Explorer >= 9. [Kevin Bieri]

1.0.0 (2016-11-30)

  • Initial implementation

Release files for ftw.candlestick 1.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ftw.candlestick 1.1.5
File Size Uploaded
ftw.candlestick-1.1.5.tar.gz 258.7 kB Details

Release files / ftw.candlestick-1.1.5.tar.gz

Download URL ftw.candlestick-1.1.5.tar.gz
Size 258.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2b7eef7e9cea8a8d18014b5b65e70d6f300660526eb1c90e671fb0b21f94c5a5
BLAKE2b-256 checksum
How to use checksums
b6c57e9f614a65a81032e44c85a0b8bd603f5cd5f21cc4f3cf0d54837edb031c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

Release history Release notifications | RSS feed

This release

1.1.5 This release

1 release file

1.1.4

1 release file

1.1.3

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.5

1 release file

1.0.4

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page