react-native/packages/rn-tester/js/examples/LinearGradient/LinearGradientExample.js

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow
 * @format
 */

'use strict';

import type {RNTesterModuleExample} from '../../types/RNTesterTypes';
import type {ViewStyleProp} from 'react-native/Libraries/StyleSheet/StyleSheet';

import RNTesterText from '../../components/RNTesterText';
import React from 'react';
import {Platform, PlatformColor, StyleSheet, View} from 'react-native';

type Props = $ReadOnly<{
  style: ViewStyleProp,
  testID?: string,
  children?: React.Node,
}>;

function GradientBox(props: Props): React.Node {
  return (
    <View style={[styles.box, props.style]} testID={props.testID}>
      {props.children}
    </View>
  );
}

const styles = StyleSheet.create({
  box: {
    width: 200,
    height: 100,
    justifyContent: 'center',
    alignItems: 'center',
    marginVertical: 10,
  },
  text: {
    color: 'white',
    fontWeight: 'bold',
  },
});

exports.title = 'Linear Gradient';
exports.category = 'UI';
exports.description = 'Examples of linear gradients applied to views.';
exports.examples = [
  {
    title: 'Basic Linear Gradient',
    description: 'Linear gradient from top to bottom',
    name: 'basic',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage: 'linear-gradient(#e66465, #9198e5);',
          }}
          testID="linear-gradient-basic">
          <RNTesterText style={styles.text}>Linear Gradient</RNTesterText>
        </GradientBox>
      );
    },
  },
  {
    title: 'Linear Gradient with corner angle',
    description: 'Rectangular Linear gradient with corner angle',
    name: 'corner-angle',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage: 'linear-gradient(45deg, red, blue);',
            height: 300,
            width: 140,
          }}
          testID="linear-gradient-corner-angle"
        />
      );
    },
  },
  {
    title: 'Multiple linear gradients',
    name: 'multiple',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage: `
                  linear-gradient(0deg, white, rgba(238, 64, 53, 0.8), rgba(238, 64, 53, 0) 70%),
    linear-gradient(45deg, white, rgba(243, 119, 54, 0.8), rgba(243, 119, 54, 0) 70%),
    linear-gradient(90deg, white, rgba(253, 244, 152, 0.8), rgba(253, 244, 152, 0) 70%),
    linear-gradient(135deg, white, rgba(123, 192, 67, 0.8), rgba(123, 192, 67, 0) 70%),
    linear-gradient(180deg, white, rgba(3, 146, 207, 0.8), rgba(3, 146, 207, 0) 70%);

            `,
            borderRadius: 16,
          }}
          testID="linear-gradient-multiple"
        />
      );
    },
  },
  {
    title: 'Diagonal Gradient',
    description: 'Linear gradient from top-left to bottom-right',
    name: 'diagonal',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage:
              'linear-gradient(to bottom right, yellow, green)',
          }}
          testID="linear-gradient-diagonal"
        />
      );
    },
  },
  {
    title: 'Gradient with angle',
    description: 'Linear gradient with angle',
    name: 'angle',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage:
              'linear-gradient(135deg, gray, brown)',
          }}
          testID="linear-gradient-angle"
        />
      );
    },
  },
  {
    title: 'Multiple Color Stops',
    name: 'color-stops',
    render(): React.Node {
      return (
        <GradientBox
          testID="linear-gradient-color-stops"
          style={{
            experimental_backgroundImage:
              'linear-gradient(to right, red 0%, yellow 30%, green 60%, blue 100%)',
          }}
        />
      );
    },
  },
  {
    title: 'Linear gradient with object style syntax',
    name: 'object-style-syntax',
    render(): React.Node {
      return (
        <GradientBox
          testID="linear-gradient-object-style-syntax"
          style={{
            experimental_backgroundImage: [
              {
                type: 'linear-gradient',
                direction: 'to bottom',
                colorStops: [
                  {color: 'purple', positions: ['0%']},
                  {color: 'orange', positions: ['100%']},
                ],
              },
            ],
          }}
        />
      );
    },
  },
  {
    title: 'Gradient with uniform border style',
    name: 'uniform-borders',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage:
              'linear-gradient(to bottom right, yellow, green);',
            borderRadius: 16,
          }}
          testID="linear-gradient-uniform-borders"
        />
      );
    },
  },
  {
    title: 'Gradient with non-uniform border style',
    name: 'non-uniform-borders',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage:
              'linear-gradient(to bottom right, yellow, green);',
            borderTopRightRadius: 8,
            borderTopLeftRadius: 80,
          }}
          testID="linear-gradient-non-uniform-borders"
        />
      );
    },
  },
  {
    title: 'Gradient with Platform colors',
    name: 'platform-colors',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage: [
              {
                type: 'linear-gradient',
                direction: 'to bottom',
                colorStops: [
                  {
                    color: Platform.select({
                      ios: PlatformColor('systemTealColor'),
                      android: PlatformColor('@android:color/holo_purple'),
                      default: 'blue',
                    }),
                    positions: ['0%'],
                  },
                  {color: 'green', positions: ['100%']},
                ],
              },
            ],
          }}
          testID="linear-gradient-platform-colors"
        />
      );
    },
  },
  {
    title: 'Transition hint',
    name: 'transition-hint',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage: 'linear-gradient(red, 40%, blue)',
          }}
          testID="linear-gradient-transition-hint"
        />
      );
    },
  },
  {
    title: 'Gradient with px and % combination',
    name: 'px-and-percentage',
    render(): React.Node {
      return (
        <GradientBox
          style={{
            experimental_backgroundImage: `linear-gradient(
              to right,
              #f15a24 0%,
              #f15a24 50px,
              #fbb03b 50px,
              35%,
              #29abe2 65%,
              180px,
              #2e3192 100%
            );`,
          }}
          testID="linear-gradient-px-and-percentage"
        />
      );
    },
  },
  {
    title: 'Non-square multiple color stops',
    name: 'non-square-multiple-color-stops',
    render(): React.Node {
      return (
        <GradientBox
          testID="linear-gradient-non-square-multiple-color-stops"
          style={{
            experimental_backgroundImage:
              'linear-gradient(45deg, black 9%, red 20%, blue 30%, green 50%, black 90%, transparent)',
            width: 100,
            height: 200,
          }}
        />
      );
    },
  },
  {
    title: 'Gradient with transparent color transition',
    name: 'transparent-color-transition',
    render(): React.Node {
      return (
        <GradientBox
          testID="linear-gradient-transparent-color-transition"
          style={{
            experimental_backgroundImage:
              'linear-gradient(to right, red, transparent)',
          }}
        />
      );
    },
  },
] as Array<RNTesterModuleExample>;