https://github.com/devpaul/modern-clippy
Modern implementations of Clippy for the web
https://github.com/devpaul/modern-clippy
Last synced: about 1 year ago
JSON representation
Modern implementations of Clippy for the web
- Host: GitHub
- URL: https://github.com/devpaul/modern-clippy
- Owner: devpaul
- Created: 2019-06-09T19:46:57.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T07:26:12.000Z (over 3 years ago)
- Last Synced: 2025-04-12T18:13:02.832Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://devpaul.github.io/modern-clippy/
- Size: 20.1 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Modern Clippy
Inspired by [Smore's ClippyJS](https://www.smore.com/clippy-js)
Modern Clippy is a reimplementation of Clippy using Web Components
[Try it out now](https://devpaul.github.io/modern-clippy/). API is below. Open the developer console and watch Clippy move!
# Component APIs
## Attributes
* `mute` if sound is muted
* `bundle` loads a json art bundle
* `dialog` describes the placement of the speech bubble for clippy: `left`, `right`, `top`, `bottom`
## Properties
* `current` READONLY string: the current animation
* `actions` READONLY string[]: a list of available actions
## Events
* `loaded`
* emitted when a bundle has loaded
* `actionStart`
* identifies when a frame starts
* `frame`
* provides frame information
* useful for coordinating dialogs
* `actionEnd`
* identifies when a frame ends
## Functions
* load(config: AgentConfiguration | string);
* loads an AgentConfiguration
* play(name: string)
* play a specific action
* playIdle()
* play a random idle animation
* stop()
* exit gracefully from the current animation
* stopImmediately()
* exit immediately from the current animation and return to idle
## Slots
* `default` slots into the speech bubble
* The dialog slot overrides any current speech being shown
# Building
## Quick Start
* npm run build