npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@haiku/player

v3.0.4

Published

Haiku Player is a JavaScript library for building user interfaces

Downloads

92

Readme

Haiku Player

The Haiku Player —
user interface engine
for SVG, DOM

NPM

Beta

Caution: Haiku Player is in beta. Expect turbulence until we arrive at cruising altitude.

Installation

yarn:

$ yarn add @haiku/player

npm:

$ npm install @haiku/player

cdn:

<!-- latest version (use caution!) -->
<script src="https://code.haiku.ai/scripts/player/HaikuPlayer.latest.js"></script>

<!-- specific version -->
<script src="https://code.haiku.ai/scripts/player/HaikuPlayer.VERSION.js"></script>

Note: Haiku Player is auto-installed in every Haiku project.

Usage

Simple:

import HaikuPlayer from "@haiku/player/dom";
const definition = { template: `<div>Hello Haiku!</div>` };
const factory = HaikuPlayer(definition);
const component = factory(document.getElementById("mount"));

Animated:

import HaikuPlayer from "@haiku/player/dom";
const definition = {
  timelines: {
    Default: {
      "#box": {
        "style.width": { 0: { value: "100px" }},
        "style.height": { 0: { value: "100px" }},
        "style.backgroundColor": { 0: { value: "red" }},
        "rotation.z": {
          0: { value: 0, curve: "linear" },
          1000: { value: 3.14159 },
        },
      },
    },
  },
  template: `
    <div id="box">Hello Animation!</div>
  `,
};
const factory = HaikuPlayer(definition);
const component = factory(document.getElementById("mount"));

Interactive:

import HaikuPlayer from "@haiku/player/dom";
const definition = {
  options: {
    autoplay: false,
  },
  states: {
    clicks: {
      value: 0,
    },
  },
  eventHandlers: {
    "#box": {
      "click": {
        handler: function () {
          this.state.clicks += 1;
          this.getTimeline("Default").play();
        },
      },
    },
  },
  timelines: {
    Default: {
      "#box": {
        "content": { 0: { 
          value: function (clicks) {
            return clicks + "";
          },
        }},
        "style.width": { 0: { value: "100px" }},
        "style.height": { 0: { value: "100px" }},
        "style.backgroundColor": { 0: { value: "red" }},
        "rotation.z": {
          0: { value: 0, curve: "linear" },
          1000: { value: 3.14159 },
        },
      },
    },
  },
  template: `
    <div id="box"></div>
  `,
};
const factory = HaikuPlayer(definition);
const component = factory(document.getElementById("mount"));

Motivation / Goals

With so many great UI libraries out there, why build this engine? Haiku Player is the bedrock of the Haiku app platform, and although we experimented with many existing libraries to meet its needs, in each case we found the architecture or goals mismatched. We opted to build an engine that would serve our plans exactly.

Conceptually, Haiku Player transforms static component definitions (see above) into animated, interactive UIs. It organizes designed elements into a scene graph in which every node can be transformed in 2.5D space. It also serves as a translation layer between the Haiku app platform and rendering APIs (e.g., the browser).

API / Docs

Complete docs are on the way. Until then, see docs.haiku.ai.

Bugs / Feature Requests / Troubleshooting

Please use GitHub Issues.

Contributing

Please send contributions via pull request.

Development

To develop Haiku Player locally:

  1. Fork the repo
  2. yarn install

Compile with:

$ yarn compile

Test with:

$ yarn test

Find formatting problems with:

$ yarn lint

License / Copyright

MIT. Please refer to LICENSE.txt. Copyright (c) 2016-2017 Haiku Systems Inc.