{"id":13789385,"url":"https://github.com/ahomu/Talkie","last_synced_at":"2025-05-12T06:31:38.565Z","repository":{"id":26362613,"uuid":"29811737","full_name":"ahomu/Talkie","owner":"ahomu","description":"Simple slide presentation library. Responsive scaling \u0026 markdown ready.","archived":false,"fork":false,"pushed_at":"2018-05-26T05:28:08.000Z","size":3658,"stargazers_count":498,"open_issues_count":1,"forks_count":31,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-25T09:08:39.436Z","etag":null,"topics":["html","markdown","rxjs","slide","talkie","typescript"],"latest_commit_sha":null,"homepage":"https://ahomu.github.io/Talkie/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahomu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-25T11:25:21.000Z","updated_at":"2024-04-14T20:45:20.000Z","dependencies_parsed_at":"2022-08-28T14:40:08.956Z","dependency_job_id":null,"html_url":"https://github.com/ahomu/Talkie","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahomu%2FTalkie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahomu%2FTalkie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahomu%2FTalkie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahomu%2FTalkie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahomu","download_url":"https://codeload.github.com/ahomu/Talkie/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252638713,"owners_count":21780621,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["html","markdown","rxjs","slide","talkie","typescript"],"created_at":"2024-08-03T22:00:21.397Z","updated_at":"2025-05-12T06:31:37.999Z","avatar_url":"https://github.com/ahomu.png","language":"TypeScript","funding_links":[],"categories":["Web Templates","TypeScript"],"sub_categories":[],"readme":"Talkie.js - Web Components based Slide library\n====================\n\n**The `master` branch is unstable because it makes comprehensive changes with v0.13. For v0.12 code, please refer to the [v0.12.x](https://github.com/ahomu/Talkie/tree/v0.12.x) branch.**\n\n[![npm version][npm-image]][npm-url] [![build status][circle-image]][circle-url] [![Dependency Status][deps-image]][deps-url]\n\nThis library written in [TypeScript](https://github.com/Microsoft/TypeScript) \u0026 [ReactiveX/rxjs: A reactive programming library for JavaScript](https://github.com/ReactiveX/RxJS).\n\nFor more information about dependency Please look at the [package.json](package.json).\n\n## Feature\n\n- [x] Markdown support\n- [x] Code highlighting\n- [x] Layout attributes\n- [x] keyboard control\n- [x] touch control\n- [x] Responsive scaling (4:3, 16:9)\n- [x] FullScreen mode\n- [x] Background image \u0026 filter\n- [x] Progress indicator\n- [x] Accessibility support\n- [ ] Pointer mode (TODO)\n- [ ] ~~Canvas drawing mode (experimental)~~ (drop v0.13~)\n\n## Real presentation sample\n\n- [WAI-ARIA IN FRESH! \u0026 AbemaTV](http://s.aho.mu/160809-a11y_informal_study/)\n- [CLIENT SIDE OF █████FRESH.TV](http://s.aho.mu/160405-node_school/)\n- [Reactive Programming in JavaScript](http://ahomu.github.io/s/150221-frontrend_conference/index.html)\n- [Bacon.js \u0026 Talkie.js](http://ahomu.github.io/s/150217-lt/index.html)\n\n## Getting started\n\nTalkie.js contains two of the CSS and one of JavaScript.\n\n- dist/talkie.min.css\n- dist/talkie.min.js\n- dist/talkie.theme-default.css\n\nNext code is the simplest example.\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n\u003chead\u003e\n\u003clink rel=\"stylesheet\" href=\"./dist/talkie.css\"\u003e\n\u003clink rel=\"stylesheet\" href=\"./dist/talkie.theme-default.css\"\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n\n\u003c!-- Pure HTML style --\u003e\n\u003ctk-slide layout\u003e\n  \u003ch1\u003eSlide 1\u003c/h1\u003e\n\u003c/tk-slide\u003e\n\n\u003c!-- Markdown style ( require `type` attribute ) --\u003e\n\u003ctk-slide layout type=\"text/x-markdown\"\u003e\n# Slide 2\n\u003c/tk-slide\u003e\n\n\u003cscript src=\"./dist/webcomponents-loader.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"./dist/talkie.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\nwindow.addEventListener('WebComponentsReady', function(e) {\n  document.body.className += ' webcomponents-ready';\n  talkie.run();\n});\n\u003c/script\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n```\n\nIf you use the code highlighting, you must load these files.\n\n```html\n\u003clink rel=\"stylesheet\" href=\"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/monokai-sublime.min.css\"\u003e\n\u003cscript src=\"//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js\"\u003e\u003c/script\u003e\n```\n\n### Slide ratio\n\nThe 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).\n\n```javascript\ntalkie.run({wide: true});\n```\n\n### Scrolling direction\n\nThe default scrollable direction is vertical. If you execute it with the following code, the scroll direction becomes horizontal.\n\n```javascript\ntalkie.run({horizontal: true});\n```\n\n### Backface image \u0026 filter\n\nYou 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.\n\n```html\n\u003ctk-slide layout\n          backface=\"background-image.jpg\"\n          backface-filter=\"blur(1px) brightness(.8)\"\u003e\n\n  \u003ch1\u003eTitle\u003c/h1\u003e\n  \u003cp\u003efoo, bar, baz, qux...\u003c/p\u003e\n\n\u003c/tk-slide\u003e\n```\n\n`backface-filter` attribute is applied to the background image as [CSS Filters](http://css-tricks.com/almanac/properties/f/filter/). But using this, will occur side effect significantly to performance on mobile device.\n\n### All options\n\n```typescript\ninterface TalkieOptions {\n  wide?: boolean; // default: false\n  horizontal?: boolean; // default: false\n}\n\ntalkie.run(options);\n```\n\n### FullScreen mode\n\nWhen you press the \u003ckbd\u003ef\u003c/kbd\u003e will be a full-screen mode. \u003ckbd\u003ef\u003c/kbd\u003e or \u003ckbd\u003eEsc\u003c/kbd\u003e Press and then exit.\n\n## Utilities\n\nMany thanks!\n\n- [ysugimoto/resumify: Capture screenshot and make PDF on your HTML presentation.](https://github.com/ysugimoto/resumify)\n- [nakajmg/talkie-generator: Templates generator for Talkie.js](https://github.com/nakajmg/talkie-generator)\n\n## Change Log\n\n### v0.13\n\n- TODO\n\n### v0.12\n\n- Add option `linkShouldBlank`.\n- Add `[horizontal]` style for default theme.\n- Fixed that transition suppression was not appropriate.\n- Update dependencies.\n\n### v0.11\n\n- Add experimental feature \"canvas drawing\". \n- Remove `Aozora Mincho` from default style.\n\n### v0.10\n\n- Improve accessibility support.\n- `aria-hidden` attribute to use instead of `visible`,\n- Rename attribute, `page` to `data-page`.\n- Rename attribute, `body-bg` to `data-body-bg`.\n- Rename attribute, `no-transition` to `data-no-transition`.\n\n### v0.9\n\n- Remove the Bacon.js, to use the [ReactiveX/rxjs](https://github.com/ReactiveX/RxJS) instead.\n- Add `TalkieExport.key: (charKey: string) =\u003e Observable\u003cKeyboardEvent\u003e`. \n- Deprecated `TalkieExport.api`\n- Deprecated `TalkieExport.controls`\n- Fixed unexpected transparent background at fullscreen.\n- Default theme some style changes.\n  - `[invert]` has been cut out from the specified value of the layout.\n  - Deprecated layouts `[title-invert]`, `[bullets-invert]`\n  - Now it is specified as `[layout=title][invert]`.\n\n## License\n\nThe MIT License (MIT)\n\n[npm-image]: https://img.shields.io/npm/v/talkiejs.svg\n[npm-url]: https://npmjs.org/package/talkiejs\n[circle-image]: https://circleci.com/gh/ahomu/Talkie.svg?style=shield\u0026circle-token=7ca8d50c44a6b81ca60ca327dc67e382a46a4829\n[circle-url]: https://circleci.com/gh/ahomu/Talkie\n[deps-image]: https://david-dm.org/ahomu/Talkie.svg\n[deps-url]: https://david-dm.org/ahomu/Talkie\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahomu%2FTalkie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahomu%2FTalkie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahomu%2FTalkie/lists"}