PakhshKit JS UI is a UI Application Framework for composing PakhshKit JS Player UI.
The PakhshKit JS UI framework enables an easy and intuitive way of customize the UI to any purpose and design, either by simple CSS definitions or by letting application define it's entire layout.
The UI framework exposes a UIManager that handles the life cycle of the UI, and and a library of components which is used to build the UI layout, where each component is responsible of a specific functionality.
Components library contains any need of the UI, but can be extended to include any additional component an application will require.
The library also exposes its default presets, which can be used as-is™ or extended.
Table of Contents
- Getting Started
- Running the Tests
The UI Manager expects a player that implements the PakhshKit JS Player interface.
First, clone and run yarn to install dependencies:
git clone https://gitlab.com/kontorol/pakhshkit-js-ui.git cd pakhshkit-js-ui yarn install
Then, build the player
yarn run build
Embed the Player In Your Test Page
Finally, add the bundle as a script tag in your page, and initialize the player
Running the Tests
Tests can be run locally via Karma, which will run on Chrome, Firefox and Safari.
yarn run test
You can test individual browsers:
yarn run test:chrome yarn run test:firefox yarn run test:safari
And Coding Style Tests
See ESLint config for full configuration.
We also use .editorconfig to maintain consistent coding styles and settings, please make sure you comply with the styling.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details