open-index/open-npm huggingface dataset:
npm package: @lightningjs/core
Description: Lightning is a (TV) app development framework that offers great portability and performance.
Author: Metrological, Bas van Meurs
Latest version: 2.20.1

# Lightning

Lightning is a (TV) app development framework that offers great portability and performance.

## SDK
[SDK](https://github.com/rdkcentral/Lightning-SDK)

## Documentation
[Documentation](https://lightningjs.io/docs/)

## Lightning 3

[Lightning 3](https://github.com/lightning-js/renderer) and [Blits](https://github.com/lightning-js/blits) are now available.

## Feedback, bugs, questions and support

In case you find any _bugs_ or have _feature requests_, feel free to open an [issue](https://github.com/rdkcentral/Lightning/issues/new) on the GitHub repository.

If you have _questions_ or need _support_ building your App with Lightning and the Lightning-SDK, then we're happy to
help you out on our [Discourse Forum](https://forum.lightningjs.io/) on [LightningJS.io](http://www.lightningjs.io).

## Contributing

The Lightning is an open source project. If you want to contribute to it, please consider the following:

- the **master** branch is the latest stable release
- the **dev** branch is used for upcoming releases
- all development should be done in dedicated *topic branches* (from latest `dev`-branch)
- please send in your PR against the `dev`-branch

Before you submit your PR, make sure you install the projects dependencies, as this will activate automatic
linting and code formatting in a Git commit hook.

## Testing

Make sure changes and new code are covered with unit tests or/and integration tests.

### Unit tests (vitest)

Test files are under `src/` with a `.test.mjs` or `.test.mts` extension.

```
npm run test
```

### Integration tests (Playwright)

Test cases are under `tests/` and use either the ES5 build output or directly point to `.mjs` files (TypeScript won't run in the browser).

```
npx playwright install
npm run build
npm run playwright:interactive
```

## Changelog

Checkout the changelog [here](./CHANGELOG.md).
npm package: @lightningjs/create-app
Description: Create a new Lightning 3 Blits App
Author: Michiel van der Geest
Latest version: 2.0.0

# Create a new Blits App

**The recommended way to start a new Lightning 3 project**

## Usage

In order to create a new L3 Blits App, all you need to do is run the following command in your terminal or command prompt:

```bash
npm create @lightningjs/app
```

You will be guided through a short series of questions to generate a new project with all the boilerplate code you need to start building your own Lightning 3 App.

Once you're done, navigate to the newly create project folder, run `npm install` and `npm run dev` to see your fresh Lightning 3 Blits App in action.
npm package: @lightningjs/create-blits
Description: Create a new Lightning 3 Blits App
Author: Sandeep Kumar Vedam
Latest version: 2.0.0

# Create a new Blits App

**The recommended way to start a new Lightning 3 project**

## Usage

In order to create a new L3 Blits App, all you need to do is run the following command in your terminal or command prompt:

```bash
npm create @lightningjs/app
```

You will be guided through a short series of questions to generate a new project with all the boilerplate code you need to start building your own Lightning 3 App.

Once you're done, navigate to the newly create project folder, run `npm install` and `npm run dev` to see your fresh Lightning 3 Blits App in action.
npm package: @lightningjs/sdk
Description: The Lightning-SDK helps you build great Lightning-based TV apps!
Latest version: 5.5.7

# Lightning SDK

The Lightning-SDK helps you build great Lightning-based TV apps!

It contains [Lightning](https://github.com/rdkcentral/Lightning) and several useful tools for App development, such as:

- Router plugin
- VideoPlayer plugin
- Image plugin
- Language plugin
- Various helpers

Check out the complete [SDK documentation](https://rdkcentral.github.io/Lightning-SDK/) for more information.

## Lightning 3

[Lightning 3](https://github.com/lightning-js/renderer) and [Blits](https://github.com/lightning-js/blits) are now available.

## Feedback, bugs, questions and support

In case you find any _bugs_ or have _feature requests_, feel free to open an [issue](https://github.com/rdkcentral/Lightning-SDK/issues/new) on the GitHub repository.

If you have _questions_ or need _support_ building your App with Lightning and the Lightning-SDK, then we're happy to
help you out on our [Discourse Forum](https://forum.lightningjs.io/) on [LightningJS.io](http://www.lightningjs.io).

## Contributing

The Lightning-SDK is an open source project. If you want to contribute to it, please consider the following:

- the **master** branch is the latest stable release
- the **dev** branch is used for upcoming releases
- all development should be done in dedicated *topic branches* (from latest `dev`-branch)
- please send in your PR against the `dev`-branch

Before you submit your PR, make sure you install the projects dependencies, as this will activate automatic
linting and code formatting in a Git commit hook.

## Changelog

Checkout the changelog [here](./CHANGELOG.md).
npm package: @lightningjs/solid-ui
Description: A shared library of components for the LightningJS Solid Framework.
Latest version: 0.18.18
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

<!--
  Copyright 2023 Comcast Cable Communications Management, LLC
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  SPDX-License-Identifier: Apache-2.0
-->

# Solid UI

This library contains shared Lightning/Solid components

## Quick Start

If you haven't already, follow the steps found [here](https://github.com/lightning-js/solid) to bootstrap your lightningjs/solid app.

1. install this package and the base theme with your package manager of choice

```sh
npm i @lightningjs/solid-ui @lightningjs/l3-ui-theme-base # or pnpm/yarn
```

2. add the theme package as an alias in your vite config

```js
// vite.config.js
  resolve: {
    alias: {
      theme: '@lightningjs/l3-ui-theme-base',
    }
  },
```

3. add the stateMapperHook to your lightningjs/solid `Config`

```js
// index.jsx
import { mapToneToStateHook } from '@lightningjs/solid-ui';
Config.stateMapperHook = mapToneToStateHook;
```

4. and finally, use a component

```jsx
// App.jsx
import { Button } from '@lightningjs/solid-ui';
<App>
  <Button>a button!</Button>
</App>;
```
npm package: @lightningjs/ui
Description: Standard UI components for Lightning
Latest version: 1.3.19

# Lightning-UI

Lightning-UI provides a set of components that are used very often when you are developing in Lightning, with the following components we hope to help you out with setting up your app a bit faster: 

* [CollectionWrapper](docs/CollectionWrapper/index.md)
    * [List](docs/CollectionWrapper/List.md)
    * [Carousel](docs/CollectionWrapper/Carousel.md)
    * [Grid](docs/CollectionWrapper/Grid.md)
* [Keyboard](docs/Keyboard/index.md)
    * [Key](docs/Keyboard/Key.md)
    * [InputField](docs/Keyboard/InputField.md)
* [ScrollingLabel](docs/ScrollingLabel.md)
* [Progress Bar](ProgressBar.md)
* [Stepper](docs/Stepper/index.md)
    * [ArrowStepper](docs/Stepper/ArrowStepper.md)
    * [CarouselStepper](docs/Stepper/CarouselStepper.md)
    * [ProgressStepper](docs/Stepper/ProgressStepper.md)
* [Color Shift](ColorShift.md)

# Install

```bash
npm i @lightningjs/ui
```

## Contributing

The Lightning-SDK is an open source project. If you want to contribute to it, please consider the following:

- the **main** branch is the latest stable release
- the **dev** branch is used for upcoming releases
- all development should be done in dedicated *topic branches* (from latest `dev`-branch)
- please send in your PR against the `dev`-branch

Before you submit your PR, make sure you install the projects dependencies, as this will activate automatic
linting and code formatting in a Git commit hook.

# Examples
In the following repository you can find code examples on how to use the components

[Ui-component-examples](https://github.com/mlapps/ui-component-examples)
npm package: @lightningjs/vite-plugin-import-chunk-url
Description: This plugin allows you to declare that a JavaScript/TypeScript file be bundled into a seperate chunk while getting the relative URL to that chunk file. The chunk can then be imported dynamically or run via a worker.
Author: Comcast Cable Communications Management, LLC
Latest version: 0.3.1

# vite-plugin-import-chunk-url

This plugin allows you to declare that a JavaScript/TypeScript file be bundled
into a seperate chunk while getting the relative URL to that chunk file. The
chunk can then be imported dynamically or run via a worker.

## Usage

**vite.config.ts**
```ts
import { importChunkUrl } from 'vite-plugin-import-chunk-url';

export default defineConfig(({ command, mode, ssrBuild }) => {
  return {
    plugins: [
      importChunkUrl(),
    ],
    build: {
      minify: false,
      sourcemap: true,
    }
  };
});
```

**app.ts**
```ts
import customModuleBundleUrl from './CustomCodeModule.js?importChunkUrl';

import(customModuleBundleUrl).then(/*..*/);
```