Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Talkie.js - Web Components based Slide library

The master branch is unstable because it makes comprehensive changes with v0.13. For v0.12 code, please refer to the v0.12.x branch.

npm version build status Dependency Status

This library written in TypeScript & ReactiveX/rxjs: A reactive programming library for JavaScript.

For more information about dependency Please look at the package.json.


  • Markdown support
  • Code highlighting
  • Layout attributes
  • keyboard control
  • touch control
  • Responsive scaling (4:3, 16:9)
  • FullScreen mode
  • Background image & filter
  • Progress indicator
  • Accessibility support
  • Pointer mode (TODO)
  • Canvas drawing mode (experimental) (drop v0.13~)

Real presentation sample

Getting started

Talkie.js contains two of the CSS and one of JavaScript.

  • dist/talkie.min.css
  • dist/talkie.min.js
  • dist/talkie.theme-default.css

Next code is the simplest example.

<!DOCTYPE html>
<link rel="stylesheet" href="./dist/talkie.css">
<link rel="stylesheet" href="./dist/talkie.theme-default.css">

<!-- Pure HTML style -->
<tk-slide layout>
  <h1>Slide 1</h1>

<!-- Markdown style ( require `type` attribute ) -->
<tk-slide layout type="text/x-markdown">
# Slide 2

<script src="./dist/webcomponents-loader.js"></script>
<script src="./dist/talkie.js"></script>
window.addEventListener('WebComponentsReady', function(e) {
  document.body.className += ' webcomponents-ready';;

If you use the code highlighting, you must load these files.

<link rel="stylesheet" href="">
<script src="//"></script>

Slide ratio

The default slide is 4:3 (width 1024px, height 768px). If you execute it with the following code, the slide ratio becomes 16:9 (width: 1366px, height 768px).{wide: true});

Scrolling direction

The default scrollable direction is vertical. If you execute it with the following code, the scroll direction becomes horizontal.{horizontal: true});

Backface image & filter

You can add backface attribute into each slides. Image path that you specify in the backface attribute will be the background of when the slide is displayed.

<tk-slide layout
          backface-filter="blur(1px) brightness(.8)">

  <p>foo, bar, baz, qux...</p>


backface-filter attribute is applied to the background image as CSS Filters. But using this, will occur side effect significantly to performance on mobile device.

All options

interface TalkieOptions {
  wide?: boolean; // default: false
  horizontal?: boolean; // default: false

FullScreen mode

When you press the f will be a full-screen mode. f or Esc Press and then exit.


Many thanks!

Change Log


  • TODO


  • Add option linkShouldBlank.
  • Add [horizontal] style for default theme.
  • Fixed that transition suppression was not appropriate.
  • Update dependencies.


  • Add experimental feature "canvas drawing".
  • Remove Aozora Mincho from default style.


  • Improve accessibility support.
  • aria-hidden attribute to use instead of visible,
  • Rename attribute, page to data-page.
  • Rename attribute, body-bg to data-body-bg.
  • Rename attribute, no-transition to data-no-transition.


  • Remove the Bacon.js, to use the ReactiveX/rxjs instead.
  • Add TalkieExport.key: (charKey: string) => Observable<KeyboardEvent>.
  • Deprecated TalkieExport.api
  • Deprecated TalkieExport.controls
  • Fixed unexpected transparent background at fullscreen.
  • Default theme some style changes.
    • [invert] has been cut out from the specified value of the layout.
    • Deprecated layouts [title-invert], [bullets-invert]
    • Now it is specified as [layout=title][invert].


The MIT License (MIT)