@edsc/earthdata-react-icons

This library exposes SVG icons in React for use in Earthdata applications, supporting both es and commonjs modules.

The library contains the following icon sets from the included libraries:

• Horizon Design System (HDS) Icons
  • hds
    • ui
    • tag
  • earthdata
    • ui
    • tag

Installation

npm install @edsc/earthdata-react-icons

Usage

Importing a single icon

...
import { ArrowChevronDown } from '@edsc/earthdata-react-icons/horizon-design-system/hds/ui'

// or...

const { ArrowChevronDown } = require('@edsc/earthdata-react-icons/horizon-design-system/hds/ui')

...

<ArrowChevronDown size="1.5rem" />

Importing all icons in a set

import * as Icons from '@edsc/earthdata-react-icons/horizon-design-system/hds/ui'

// or...

const Icons = require('@edsc/earthdata-react-icons/horizon-design-system/hds/ui')

...

<Icons.ArrowChevronDown size="1.5rem" />

Styling the icons

By default, icons are designed to inherit the current css text color via a currentColor fill in the svgs.

<div style={{ color: 'blue' }}>
  <ArrowChevronDown />
</div>

Changing the size of an icon

By default, icons set to 1rem so they will be using the base font size for the html element. The size can be modified by setting a size prop.

<ArrowChevronDown size="2rem" />

Adding custom attributes to the svg

Except for a few excluded props, custom props can be defined on the icon.

<ArrowChevronDown aria-label="A arrow pointing down" />

Example Applications

By default, the example projects import the modules directly from the parent dist folder to ease local development. Alternatively, the examples can be installed using a local npm package, or the deployed package.

To view the example application using the dist output

# Build the icons
npm run build

# Move to the esmodule application, or...
cd example-mjs

#  Move to the commonjs application
cd example-js

# Start the example application
npm install
npm run dev

To view the example application using the a locally built package

# Build the icons
npm run build

# Package the npm module. This should generate a file in the
# root directory named `@edsc/[email protected]`,
# where `0.0.1` is the current version.
npm pack

# Move to the esmodule application, or...
cd example-mjs

#  Move to the commonjs application
cd example-js

# Start the example application
npm install
npm install ../edsc-earthdata-react-icons-0.0.1.tgz # Make sure to match the version :)
npm run dev

To view the example application using the deployed package

# Build the icons
npm run build

# Move to the esmodule application, or...
cd example-mjs

#  Move to the commonjs application
cd example-js

# Start the example application
npm install
npm install @edsc/earthdata-react-icons
npm run dev

Contributing

See CONTRIBUTING.md

License

Copyright © 2007-2024 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.