JSPM

  • Created
  • Published
  • Downloads 48636
  • Score
    100M100P100Q150284F

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

Package Exports

  • @gluestack-ui/icon
  • @gluestack-ui/icon/lib/commonjs/index.js
  • @gluestack-ui/icon/lib/module/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@gluestack-ui/icon) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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.