Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ngfx/ui

steveblue14MIT1.0.0-beta.3TypeScript support: included

Angular UI library for gaming and creative applications

ui, front end, angular, gaming, creative, joystick, slider, component, library

readme

@ngfx

Join the chat at https://gitter.im/ngfx-dev/Lobby

Angular Component Library

This repository is a development environment for the @ngfx Component library. This project contains Angular library packages for connecting touch based UI controls over WebRTC DataChannel. More packages for working with canvas, WebGL, audio, and video coming soon.

Packages

Package Description
rtc A service for connecting p2p over WebRTC DataChannel
ui UI component library for gaming and creative apps

NgFxControl

NEW in 1.0.0-beta.3!

Sliders, joysticks, and buttons transmit messages over WebRTC DataChannel with @ngfx/rtc.

Example of UI Controller built with @ngfx/ui

Install

@ngfx is distributed as a scoped package on npm. All packages are provided under this namespace.

npm i @ngfx/rtc @ngfx/ui yarn add @ngfx/rtc @ngfx/ui

Wiki

For more information about the ngfx library visit the wiki.

Contributing

If you are interested in contributing, fork the repository and submit pull requests targeting the develop branch.

Support

Get help in the ngfx Gitter

Roadmap

Package Description
canvas Supports working with <canvas> and <svg>
gl Bridges the gap between Angular and WebGL
audio Supports working with <audio> tag and Web Audio API
video Supports building a video player with the <video> tag

This project is built with angular-rollup.

changelog

CHANGELOG

1.0.0-beta.4

  • NEW NgFxToggleComponent displays a toggle button
  • NEW size property on NgFxControl can display components at different sizes
  • NEW themes display NgFxControl in dark or light theme
  • UPDATE NgFxButtonComponent to display icons centered in button when NgFxControl currentValue is true or false
  • UPDATE look and feel for NgFxSliderComponent, NgFxButtonComponent

1.0.0-beta.3

  • NEW @ngfx/ui package includes UI Components
  • NEW NgFxSurfaceComponent displays NgFxControl on css grid
  • NEW NgFxSliderComponent displays a slider or joystick
  • NEW NgFxButtonComponent displays a button
  • NEW NgFxControl schema describes a user controllable element
  • NEW NgFxEvent schema describes events emitted by NgFxControls
  • NEW NgFxSurface schema describes a control surface
  • NEW NgFxController service handles CRUD for NgFxSurfaces
  • UPDATE NgFxDataChannel to promise based WebRTC offer / answer pattern
  • UPDATE NgFxDataChannel to support Apple Safari 11+ and Mozilla Firefox