wikipedia-preview

CircleCI

Wikipedia Preview

Wikipedia Preview is a JavaScript component that allows you to provide context from Wikipedia about words or phrases on any website. It lets you show a popup card with a short summary from Wikipedia when a reader hovers over a link.

Tasks and issues are tracked on Phabricator.

Desktop Mobile
Chat Chat

Storybook: https://wikimedia.github.io/wikipedia-preview/storybook-static

Compatibility

Browsers Versions
Chrome, Firefox, Opera, Edge Current and previous version
Internet Explorer 11+
Safari 5.1+
iOS 6.1+
Android 4.1+

Features

Getting Started

Integrating Wikipedia Preview to your site consists of a three-step process:

  1. Loading wikipedia-preview.js (either as a standalong script or an npm dependency)
  2. Invoking wikipediaPreview.init( <options> )
  3. Annotating articles accordingly

You can read more about each step below. Once Wikipedia Preview is set up correctly, you should see the version information being logged in your JS console. You can also invoke wikipediaPreview.version() from your JS console to view version information at any time.

Standalone Script

<script src="wikipedia-preview.production.js"></script>
<script type="text/javascript">
  wikipediaPreview.init()
</script>

You can serve the file yourself or include it from unpkg.

NPM

$ npm install wikipedia-preview --save
const wikipediaPreview = require('wikipedia-preview')
wikipediaPreview.init()

Options of the init function

The init function accepts the following options:

Name Type Default Description
root DOM Element document Where to look for elements that should have the popup
selector string '[data-wikipedia-preview]' How nodes that should have the popup are identified
lang string 'en' Default Wikipedia language
popupContainer DOM Element document.body Where to put the popup in the DOM
detectLinks Boolean false Allow Wikipedia hyperlinks to have the popup
events Object {} Custom event handlers: { onShow: <fn>, onWikiRead: <fn> }
debug Boolean false Shows the debug message when init() is called

Example (custom selector)

<p class="content">
	You can learn about <span class="wiki">Chat</span> and <span class="wiki">Chien</span> from Wikipedia.
</p>
<div class="popup-container"></div>
wikipediaPreview.init({
	root: document.querySelector('.content'),
	selector: '.wiki',
	popupContainer: '.popup-container',
	lang: 'fr'
});

Example (detect Wikipedia links)

<p class="content">
	You can learn about <a href="https://en.wikipedia.org/wiki/Chat">Chat</a> and <a href="https://en.wikipedia.org/wiki/Chien">Chien</a> from Wikipedia.
</p>
wikipediaPreview.init({
	detectLinks: true
});

Example (custom event handlers)

wikipediaPreview.init({
	events: {
		onShow: function(title, lang, type) {
			// call custom instrumentation here
		},
		onWikiRead: function(title, lang) {
			// call custom instrumentation here
		}
	}
});

Attributes

data-wikipedia-preview

To indicate that a word or expression should bring up the article preview popup, mark it with the data-wikipedia-preview attribute (or anything else as long as you’re using the selector option described above).

data-wp-title

When the article title is not the same as the node’s textContent property, use the data-wp-title attribute to specify the article title.

data-wp-lang

To use a language different than the language specified in the options, use the data-wp-lang attribute.

.wmf-wp-with-preview

To use the default trigger link styling:

* Add the class `wmf-wp-with-preview` to the node

If you prefer to style them in a way that makes more sense for your context, simply don't include the `wikipediaPreview.css` link in the header and add your own class to the node. Both of these are valid ways:

```CSS
[data-wikipedia-preview] {
	background-color: yellow;
}
.my-own-css-style {
	background-color: yellow;
}

Acknowledgements/Contributors

This is heavily inspired by jquery.wikilookup and Page Previews.