<!--
  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
-->

import { Canvas, Story } from '@storybook/addon-docs';
import ListItemSlider from '.';

# ListItemSlider

A ListItem component with slider functionality

## Source

https://github.com/rdkcentral/Lightning-UI-Components/blob/develop/packages/%40lightningjs/ui-components/src/components/ListItem/ListItemSlider.js

## Usage

The `ListItemSlider` can display a `title` and `value`

```js
import { ListItemSlider } from '@lightningjs/ui-components';

class Basic extends lng.Component {
  static _template() {
    return {
      ListItemSlider: {
        type: ListItemSlider,
        title: 'List Item',
        value: 50
      }
    };
  }
}
```

<Canvas>
  <Story id="components-listitemslider--list-item-slider" />
</Canvas>

## API

### Properties

| name   | type   | required | default   | description                                                                                                |
| ------ | ------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| slider | object | false    | undefined | object containing all properties supported in the [Slider component](?path=/docs/components-slider--basic) |
| value  | string | false    | undefined | current value of slider                                                                                    |

### Style Properties

| name           | type   | description                      |
| -------------- | ------ | -------------------------------- |
| paddingY       | number | space above and below the slider |
| sliderStyles   | object | overwrite any styles in slider   |
| valueTextStyle | object | text style to apply to the value |
