npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

oui-icons

v3.10.0

Published

Icons for the Optimizely application and other OUI projects.

Downloads

1,017

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

optimizely-engoptimizely-engdanocdanockwalker3690kwalker3690mikeng13mikeng13delikatdelikatjessicalcjessicalcoptimizely-frontendoptimizely-frontendoptidaveoptidaveoptinakioptinaki

Keywords

Readme

Build Status

OUI Icons

Icons for the Optimizely application and other OUI projects.

View all the icons.

Using the icons

  1. Download the package: Run npm install --save oui-icons to include the latest icons in your project.

  2. Include the SVG sprite: This package ships with an SVG sprite that contains all of the icons. Include the SVG sprite at the beginning of your website’s <body> tag. The sprite can be referenced with require('oui-icons') if using a project with webpack and an SVG loader. Projects not using webpack can include the sprite by including the icons with your templating engine: ./node_modules/oui-icons/dist/combined/svg-symbols.svg.

  3. Using an icon: You can use one of the icons in the HTML with:

    <svg>
  <use xlink:href="#code-24"></use>
</svg>

    The complete list of icons can be found at: link.otimizely.com/oui-icons.

Adding and editing icons

  1. Add the icon to the appropriate folder in src/.
  2. Update the CHANGELOG.md to include information about the change in the “Unreleased” section. Here are some tips:
  • Each list item falls under one of the following categories: Added, Changed, Fixed, or Removed.
  • Each item is labeled either [Patch], [Feature], or Release.
    • [Patch]: Backwards compatible fixes (patches) to existing icons, infrastructure, or documentation.
    • [Feature]: New icons or features that are backwards compatible.
    • [Release]: Changes that are not backwards compatible such as the removal of an icon.
  • Changes should always be added in the “Unreleased” section.
  1. Create a pull request on GitHub and assign a UI Engineer or Frontend Engineer.

Releasing a new version

Prerequisite

  • You must have deploy access to design.optimizely.com and be listed as a contributor on the oui-icons NPM package. Contact a UI Engineer for help.
  • You must be using a version of NPM larger than 2.11.0. This is when NPM added support for the postversion hook that we rely on. You can check your version by running npm -v in the command line.

How to release

  1. Run git checkout master && git pull.
  2. Open the CHANGELOG.md, update to reflect the new version, and commit the change. Here are some tips:
  • The new version number depends on the severity of the changes in the version that is being released. Here are examples:
    • [Release] – 1.2.3 would become 2.0.0.
    • [Feature] – 1.2.3 would become 1.3.0.
    • [Patch] – 1.2.3 would become 1.2.4.
  • The commit should include the CHANGELOG.md update. The message could be: “Prep for 3.1.3 release.”
  • Do not update the package.json in this step.
  • There should be nothing left in the “Unreleased” section.
  1. Run the command that matches the highest severity change in this release:
  • npm version patch - version includes a backwards-compatible bug fix or tweak. This includes small icon style modifications.
  • npm version minor - version includes a backwards compatible new "feature" such as a new icon.
  • npm version major - version contains a non-backwards compatible breaking change such as a renamed or deleted icon.