<!--
  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 Gradient from '.';

# Gradient

A semitransparent Gradient to be used on top of any component, like Artwork.

## Source

https://github.com/rdkcentral/Lightning-UI-Components/blob/develop/packages/@lightningjs/ui-components/src/components/Gradient/Gradient.js

## Usage

Specify a width and height and overlay to Tiles or other items.

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

class Example extends lng.Component {
  static _template() {
    return {
      Gradient: {
        type: Gradient,
        w: 320,
        h: 180
      }
    };
  }
}
```

<Canvas>
  <Story id="components-gradient--gradient" />
</Canvas>

## API

### Style Properties

| name          | type   | description                             |
| ------------- | ------ | --------------------------------------- |
| gradientColor | number | default color the gradient fades to     |
| gradientTop   | number | default starting color for the gradient |
| radius        | number | default gradient corner radius          |
