Giter VIP home page Giter VIP logo

tts-engine's Introduction

ttsreader is a text-to-speech tech wrapper & player

TL;DR

``

See published npm package

Import:

  • Web - with ttsreader's latest version: <script src="https://unpkg.com/ttsreader/build/bundle.min.js"></script>
  • Web
  • Node: npm i data-ws-hooks

How to use?

Important! This works if css defines class "hidden" as "display:none", as the hiding here works by toggling this class

- HTML Attributes

Attribute Note Example
data-ws-onclick When element is clicked - it will trigger one of the 3, in that order of precedence:
- Fire an action, like hide all elements of class x. See list of actions later.
- Fire a window.wsGlobals function
- Fire a global window function. Supports nested functions by dot notation.
- <button data-ws-onclick="hideClass:popup">Close popup</button>
- <button data-ws-onclick="signin">Sign In</button>
data-ws-src Sets a "src" attribute with its value as the "data-ws-src", so to lazy load src instead of blocking the user experience. - <iframe data-ws-src="/embedded/feedback_form.html"/>
data-ws-tab Combined with the classes: "tab-selector", "tab-selector selected", "tab-section", "tab-section hidden" it gives a tab functionality.
Important! Allows a single set of tabs per page!
<div><span class="tab-selector selected" data-ws-tab="tab1">Tab1</span><span class="tab-selector" data-ws-tab="tab2">Tab2</span></div>
data-ws-toggle-hidden-data Defines elements to be toggled 'hidden' class when a respective button is clicked. <div data-ws-toggle-hidden-data='signin-dialog'>...</div>
data-ws-toggle-hidden-button When clicked, toggle 'hidden' class on all elements that share the value in their "data-ws-toggle-hidden-data" attribute. <button data-ws-toggle-hidden-button='signin-dialog'>Sign In</button>

- Built-in onclick actions

Run as: data-ws-onclick="some_action:optional_param"

Actions Note Example
hideClass:some_class Hide all elements of class some_class. - <button data-ws-onclick="hideClass:popup">Close popup</button>
copy: Copy the value attribute of clicked element - <input data-ws-onclick="copy" type:"text" value="this will be copied"/>
copy:#some_element_id Copy the value attribute of #some_element_id element - <button data-ws-onclick="copy:#some_element_id" >Copy</button>

Showcases

This is used on the following sites:

TODOs:

  • It sometimes hides by styling directly and sometimes by toggling "hidden" class. Inconsistent...
  • Allow more than a single set of tabs on page... Perhaps contain tabs in a parent...

How to contribute & publish updates to this package?

  • This package is published both on GitHub and on npmjs.
  • To publish an updated version - simply run npm publish, it will commit & push updates both to github and npm.

tts-engine's People

Contributors

ronenr avatar

Stargazers

Daniel Weck avatar

Watchers

Daniel Weck avatar  avatar

tts-engine's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.