@astrouxds/rux-icon

Astro Web Component for Icons

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@astrouxds/rux-icon
Minified + gzip package size for @astrouxds/rux-icon in KB

Readme

Icons

Display icons used in the Astro Design System

Guidelines

Installation

npm i -save @astrouxds/rux-icon

Web Components Usage

1. Installation

Install the Astro UXDS Icon package via Command Line (Preferred Method)

npm i --save @astrouxds/rux-icon

You may use Yarn, NPM, or your Node package manager of choice. The --save flag adds this component as a dependency in your package.json file.

Alternatively, download the Astro Component Library source to your project.

Via CLI:

git clone https://github.com/RocketCommunicationsInc/astro-components.git

Or, download the Astro UXDS Components as a .zip

2. Import the Astro Icon Web Component

This example assumes you're using the NPM package in node_modules. Otherwise, import the component using the path to the Astro Components directory in your project.

import { RuxIcon } from "@astrouxds/rux-icon/rux-icon.js";

3. Render the Astro Icon Web Component

Pass properties as attributes of the Astro Icon custom element:

<rux-icon icon="altitude" label="Altitude" color="#fff" ></rux-icon>

Properties

Property Type Default Required Description
icon String '' Yes Displays an icon matching this string. For a full list of available icons in the Astro default library, see the Icons section in Astro UXDS Guidelines
label String '' Yes A descriptive label of the icon.
library String '/icons/astro.svg' No Defines the root-relative path for a specific icon library SVG for this icon. An icon library SVG document has individual icon elements identified by an id property on the node (usually on a <g> or <path>). If a value for library is not provided, the icon component assumes the Astro library SVG exists at the default path, and will look for the icon by id there.
color String 'rgb(77, 172, 255)' No Applies a custom fill color as a valid HTML color string, e.g., hexadecimal, RGBA or HSL value.
size String 'normal' No Adjusts icon size, supported values are extra-small (16px), small (32px), normal (44px) and large (64px)

Custom icons

Access an external (non-Astro) icon library via the library attribute, which requires a root-relative path to an SVG file where the component's icon string attribute matches an element's id.

<rux-icon library="/icons/my-custom-icons.svg" icon="my-icon"></rux-icon>

In the SVG icon library file:

<svg>
    <defs>
        <g id="my-icon">...

Revision History

4.0
  • Removed the namespace:icon pattern in favor of supporting multiple libraries, both default (Astro) and external, adding the library property (see Astro 4 migration note below)
  • Replaced the DOM manipulation library for loading icons in favor of an HTML5 template TODO: add support for template outside of WebComponents when browser’s support shadowDOM piercing
  • Moved Astro Status Icons to their own package, rux-status
  • Replaced Polymer 3 implementation with LitElement for improved speed and interoperability with JS Frameworks as well as simpler template declaration now available in vanilla JavaScript.
  • Extended icon set with Google Material Design icons. License: https://github.com/google/material-design-icons/blob/master/LICENSE

Important Astro 4 Migration Note:

Prior to Astro 4.0, the Astro UXDS Icon Component imported icons from a single SVG file where icons were identified by id under specific groups. In that method, icons were accessed via a namespaced value for the icon property, such as "group-id:icon-id".

Prior to Astro 4.0:

<rux-icon icon="default:settings"></rux-icon>

In Astro 4.0, these groups have been flattened, and each icon is now imported directly without any group prefix. If you would like to load another icon library SVG file, use the library property. You can easily namespace your own custom icons (e.g., my-namespaced-prefix_settings) and access those icons via the icon attribute.

Astro 4.0 with default Astro icons:

<rux-icon icon="settings"></rux-icon>

Astro 4.0 with custom icons:

<rux-icon library="/icons/my-namespaced-custom-icons.svg" icon="my-namespaced-prefix_settings"></rux-icon>

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.