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

Package detail

@gluestack-ui/icon

gluestack141k0.1.27TypeScript support: included

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

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

readme

@gluestack-ui/icon

Installation

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

$ yarn add @gluestack-ui/icon

# or

$ npm i @gluestack-ui/icon

Usage

Whether you're building a simple form or a complex data collection system, the icon component offers a user-friendly way for users to select multiple options from a list. Here's an example how to use this package to create one:

import { Root } from '../components/core/icon/styled-components';
import { createIcon } from '@gluestack-ui/icon';
const Icon = createIcon({
  Root,
});

Customizing the icon:

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

// import the styles
import { Root } from '../components/core/icon/styled-components';

// import the createIcon function
import { createIcon } from '@gluestack-ui/icon';

// Understanding the API
const Icon = createIcon({
  Root,
});

// Using the icon component
export default () => <Icon />;

More guides on how to get started are available here.

changelog

Changelog

Latest Release

December 23, 2022: v0.1.0

Previous Releases