https://github.com/liqvidjs/liqvid

Library for interactive videos in React
https://github.com/liqvidjs/liqvid

animation javascript liqvid react video

Last synced: 3 months ago
JSON representation

Library for interactive videos in React

• Host: GitHub
• URL: https://github.com/liqvidjs/liqvid
• Owner: liqvidjs
• License: mit
• Created: 2018-11-09T07:10:46.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-06-13T03:22:51.000Z (5 months ago)
• Last Synced: 2024-06-17T05:31:01.352Z (5 months ago)
• Topics: animation, javascript, liqvid, react, video
• Language: TypeScript
• Homepage: https://liqvidjs.org
• Size: 1.34 MB
• Stars: 745
• Watchers: 17
• Forks: 38
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Liqvid

[Liqvid](https://liqvidjs.org/) is a library for creating **interactive** videos in React.

## Links

[Documentation](https://liqvidjs.org/docs/)

[Discord](https://discord.gg/u8Qab99zHx)

## Repository structure

This is a monorepo. Here is what the various packages do:

### Frontend Core

* `main`  

Provides the main `liqvid` package.

* `host`  

Script for pages hosting Liqvid videos; currently just handles [fake fullscreen](https://liqvidjs.org/docs/guide/mobile#fake-fullscreen)

* `keymap`  

Provides the [`Keymap`](https://liqvidjs.org/docs/reference/Keymap) class

* `playback`  

Provides the [`Playback`](https://liqvidjs.org/docs/reference/Playback) class

* `polyfills`  

Polyfills for Liqvid videos; currently just handles [Web Animations](https://liqvidjs.org/docs/guide/mobile/#web-animations)

* `utils`  

Provides the various helper functions in [`Utils`](https://liqvidjs.org/docs/reference/Utils/animation)

### Backend Tools

* `cli`  

The Liqvid [CLI tool](https://liqvidjs.org/docs/cli/tool)

* `magic`  

Provides wacky[resource macro](https://liqvidjs.org/docs/cli/macros) syntax

* `renderer`  

Handles the [`audio`](https://liqvidjs.org/docs/cli/audio), [`build`](https://liqvidjs.org/docs/cli/build), [`render`](https://liqvidjs.org/docs/cli/render), and [`thumbs`](https://liqvidjs.org/docs/cli/thumbs) CLI commands

* `serve`  

Development server; provides the [`serve`](https://liqvidjs.org/docs/cli/tool) CLI command

### Integrations

* `katex`  

Provides [KaTeX integration](https://liqvidjs.org/docs/integrations/katex)

* `react-three`  

Provides [React Three Fiber](https://liqvidjs.org/docs/integrations/three) integration

### In-development

* `captioning`  

Captions editor

* `gsap`  

[GSAP](https://greensock.com/gsap/) integration (maybe already works???)

* `i18n`  

Internationalization utilities

* `player`  

New Web Components-based ``

* `mathjax`  

[MathJax](https://www.mathjax.org/) integration

* `react`  

Probably for when Liqvid goes to Web Components (v3)

* `xyjax`  

[XyJax](https://github.com/sonoisa/XyJax-v3/) integration