Logo for jsDocs.io

react-icons

  • Version 5.5.0
  • Published
  • 86.2 MB
  • No dependencies
  • MIT license

Install

npm i react-icons
yarn add react-icons
pnpm add react-icons

Overview

SVG React icons of popular icon packs using ES6 imports

Index

Variables

Functions

Interfaces

Type Aliases

Variables

variable DefaultContext

const DefaultContext: IconContext;

    variable IconContext

    const IconContext: React.Context<IconContext>;

      variable IconsManifest

      const IconsManifest: IconManifestType[];

        Functions

        function GenIcon

        GenIcon: (data: IconTree) => (props: IconBaseProps) => React.JSX.Element;

          function IconBase

          IconBase: (
              props: IconBaseProps & { attr?: Record<string, string> }
          ) => JSX.Element;

            Interfaces

            interface IconBaseProps

            interface IconBaseProps extends React.SVGAttributes<SVGElement> {}

              property children

              children?: React.ReactNode;

                property color

                color?: string;

                  property size

                  size?: string | number;

                    property title

                    title?: string;

                      interface IconContext

                      interface IconContext {}

                        property attr

                        attr?: React.SVGAttributes<SVGElement>;

                          property className

                          className?: string;

                            property color

                            color?: string;

                              property size

                              size?: string;

                                property style

                                style?: React.CSSProperties;

                                  interface IconManifestType

                                  interface IconManifestType {}

                                    property id

                                    id: string;

                                      property license

                                      license: string;

                                        property licenseUrl

                                        licenseUrl: string;

                                          property name

                                          name: string;

                                            property projectUrl

                                            projectUrl: string;

                                              interface IconTree

                                              interface IconTree {}

                                                property attr

                                                attr: {
                                                    [key: string]: string;
                                                };

                                                  property child

                                                  child: IconTree[];

                                                    property tag

                                                    tag: string;

                                                      Type Aliases

                                                      type IconType

                                                      type IconType = (props: IconBaseProps) => React.ReactNode;

                                                        Package Files (4)

                                                        Dependencies (0)

                                                        No dependencies.

                                                        Dev Dependencies (0)

                                                        No dev dependencies.

                                                        Peer Dependencies (1)

                                                        Badge

                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-icons.

                                                        • Markdown
                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/react-icons)
                                                        • HTML
                                                          <a href="https://www.jsdocs.io/package/react-icons"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>