Skip to content

Commit

Permalink
Add a demo showing how to add app to Edge sidebar (#457)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaifroid authored Sep 16, 2023
1 parent 8627c01 commit a7bd28e
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Kiwix JS for PWA, Windows and Linux (Electron, NWJS, UWP)

Demos: [ [Installing the PWA](screenshots/Install-PWA.md) ] [ [Picking a folder of archives](screenshots/Folder-Picking.md) ] [ [Adding app to Edge sidebar](screenshots/Add-KiwixPWA-to-Edge-sidebar.md) ]

![Kiwix JS Seven Wonders Montage trans](https://user-images.githubusercontent.com/4304337/218268736-2820050c-289f-4d4b-aef9-7e9f4f33c658.png)

**Kiwix is an offline browser for Wikipedia, Project Gutenberg, TED Talks, Wikivoyage, Stackexchange, and many other sites and resources.
Expand Down
15 changes: 15 additions & 0 deletions screenshots/Add-KiwixPWA-to-Edge-sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# How to add Kiwix JS PWA to the Edge sidebar

This is a new feature of the Microsoft Edge browser. Simply enable the sidebar in Settings, then go to https://pwa.kiwix.org, click the plus sign in
the sidebar, then "Add current page". More info after the demo.

![Add Kiwix PWA to Edge sidebar](Add-KiwixPWA-to-Edge-sidebar_demo.gif)

## For best results

You may need to adjust the width of the bar so that all the icons fit. You can also reduce the size of the UI in Configuration if you'd like a snugger
fit. Please note that the current icon is white, which means it is more visible if the Edge theme is set to "Dark". We are looking into adding an
outline to the favicon that is used in order to make it more visible in light mode.

Please note that due to a [Chromium bug](https://bugs.chromium.org/p/chromium/issues/detail?id=1368818#c13) (which also affects extensions), folder picking is not available in the sidebar, so please simply pick the
file you want to load rather than picking a folder of archives.
Binary file added screenshots/Add-KiwixPWA-to-Edge-sidebar_demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions screenshots/Install-PWA.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,7 @@ If you grant this permission permanently (tick the check box), you won't be both
When you open a ZIM archive or folder *from within the app* (from Configuration), you are asked for permission to access the file or the folder containing your ZIM archives. On next
launch, the selected file or folder is remembered. When you click on the archive name, you are given a quick permissions prompt (just once per launch). This is a security feature of
the API and can't currently be avoided.

## Add the PWA to the Edge sidebar

If you are using Microsoft Edge (Chromium), you can now add the PWA to the Edge sidebar. See our demo [Add Kiwix PWA to Edge sidebar](Add-KiwixPWA-to-Edge-sidebar.md).

0 comments on commit a7bd28e

Please sign in to comment.