Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@gluestack-ui/linear-gradient

gluestack2.7k0.1.3TypeScript support: included

A universal headless LinearGradient component for React Native, Next.js & React

react, native, react-native, linear-gradient, gluestack-ui, universal, headless, typescript, component, android, ios, nextjs

readme

@gluestack-ui/linear-gradient

Installation

To use @gluestack-ui/linear-gradient, all you need to do is install the @gluestack-ui/linear-gradient package:

$ yarn add @gluestack-ui/linear-gradient

# or

$ npm i @gluestack-ui/linear-gradient

Usage

A linear-gradient component is a graphical user interface element that enables users to act by clicking or tapping. It can be customized in size, shape, color, and behavior to fit the design of the application or website. Here's an example how to use this package to create one:

import { createLinearGradient } from '@gluestack-ui/linear-gradient';
import {
  Root,
  Text,
  Group,
  GroupHSpacer,
  GroupVSpacer,
  Spinner,
  Icon,
} from './styled-components';

export const LinearGradient = createLinearGradient({
  Root,
  Text,
  Group,
  GroupHSpacer,
  GroupVSpacer,
  Spinner,
  Icon,
});

Customizing the LinearGradient:

Default styling of all these components can be found in the components/core/linear-gradient file. For reference, you can view the source code of the styled LinearGradient components.

// import the styles
import {
  Root,
  Text,
  Group,
  GroupHSpacer,
  GroupVSpacer,
  Spinner,
} from '../components/core/linear-gradient/styled-components';

// import the createLinearGradient function
import { createLinearGradient } from '@gluestack-ui/linear-gradient';

// Understanding the API
const LinearGradient = createLinearGradient({
  Root,
  Text,
  Group,
  GroupHSpacer,
  GroupVSpacer,
  Spinner,
});

// Using the linear-gradient component
export default () => (
  <LinearGradientGroup>
    <LinearGradient>
      <LinearGradientText />
      <LinearGradientSpinner />
      <LinearGradientIcon />
    </LinearGradient>
  </LinearGradientGroup>
);

More guides on how to get started are available here.

changelog

Changelog

Latest Release

December 23, 2022: v0.1.0

Previous Releases