Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add widget support #797

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add widget support #797

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
489dfc1
Give a name to function for updating book count
juuz0 Jul 16, 2022
efe42c9
Add widget endpoint
juuz0 Jul 10, 2022
d27220f
Give name to IIFE in index.js and expose updateBookCount
juuz0 Jul 28, 2022
58c04b3
Basic widget handling
juuz0 Jul 11, 2022
09dc6f9
Add custom CSS and JS support
juuz0 Jul 28, 2022
fc87def
Add documentation for widget
juuz0 Jul 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Welcome to libkiwix's documentation!

usage
api/ref_api
widget
82 changes: 82 additions & 0 deletions docs/widget.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
Kiwix serve widget
====================

Introduction
------------

The kiwix-serve widget provides an easy to embed way to show the `kiwix-serve` homepage.

Usage
-----

To use the widget, simply add an iframe with its `src` attribute set to the `widget` endpoint.
Example HTML Page ::

<!DOCTYPE html>
<html lang="en">
<head>
<title>Widget Test</title>
</head>
<body>
<iframe src="http://192.168.18.8:8080/widget?disabledesc&disablefilter&disabledownload" width=1000 height=1000></iframe>
</body>
</html>

This creates an iframe with the kiwix-serve homepage contents.

Arguments are explained below.

Possible Arguments
-------------------

Currently, the following arguments are supported.

disabledesc (value = N/A)
Disables the description part of a tile.

disablefilter (value = N/A)
Disables the search filters: language, category, tag and search function.

disableclick (value = N/A)
Disables clicking the book to open it for reading.
Comment on lines +40 to +41
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me (Firefox 103.0) a blank tab is opened


disabledownload (value = N/A)
Disables the download button (if avaialable at all) on the tile.


Custom CSS and JS
-----------------

You can add your custom CSS rules and Javascript code to the widget.

To do that, use the following code as template::

<iframe id="receiver" src="http://192.168.18.8:8080/widget?disabledesc=&disablefilter=&disabledownload=" width="1000" height="1000">
<p>Your browser does not support iframes.</p>
</iframe>

<script>
window.onload = function() {
var receiver = document.getElementById('receiver').contentWindow;
function sendMessage() {
let msg = {
css: `
.book__header {
color:red;
}`,
js: `
function widgetTest() {
console.log("Testing widget");
}
widgetTest();
`
}
receiver.postMessage(msg, 'http://192.168.18.8:8080/widget');
}
sendMessage();
}
</script>


The CSS/JS fields are optional, you may send both or only one.