Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dazn/kopytko-framework) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Kopytko Framework
Kopytko Framework is a simple framework created to build simpler and cleaner components in Roku SceneGraph, allowing you to write component code declaratively instead of imperatively, leading to a less error-prone codebase and improving its maintainability overall. It is highly inspired by the Javascript library React and follows a lot of its patterns as well as its API, making it extremely friendly for someone coming from a React components environment. It is also inspired by router of the Javascript Angular framework and some other mechanisms taken from the Javascript world.
Kopytko Roku Ecosystem
Kopytko Framework is part of Kopytko Roku Ecosystem which consists of:
- Kopytko Framework,
- Kopytko Utils - a collection of modern utility functions for Brightscript applications,
- Kopytko Packager - a package builder for the Roku platform,
- Kopytko Unit Testing Framework - extended Roku's Unit Testing Framework with additional assert functionalities and the mocking mechanism,
- Kopytko ESLint Plugin - set of Brightscript rules for ESLint
Kopytko Framework, Utils and Unit Testing Framework are exportable as Kopytko Modules, so they can easily be installed and used in apps configured by Kopytko Packager.
Modules
- Renderer: main module, inspired by JS React library, rendering components. Full documentation available in docs/renderer.md
- Router: enables building an app with multiple views and allows navigation between them. Docs available in docs/router.md
- Cache: a mechanism to store expirable external data. Full documentation available in docs/cache.md
- EventBus: implementation of Pub/Sub simplifying the communication between components. Full documentation available in docs/event-bus.md
- HTTP: easy way to send HTTP requests. Full documentation available in docs/http.md
- Modal: global UI component. Full documentation available in docs/modal.md
- Registry: a facade over native Roku's registry. Full documentation available in docs/registry.md
- Store: a mechanism to store reusable data. Docs available in docs/store.md
- Theme: manages UI configuration and allows easy use in any place. Full documentation available in docs/theme.md
Versions migration
To update Kopytko Framework to the latest major version, please follow the Versions migration guide