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

@lifterlms/fontawesome

v0.0.1

Published

A no-conflict fork of Font Awesome for use in LifterLMS projects.

Downloads

4

Readme

LifterLMS Font Awesome

A wrapper around Font Awesome and a collection of related React components for use in LifterLMS projects.


Changelog

View the Changelog

Configure and generate CSS files

To create the relevant CSS file which includes all the free icons and necessary CSS classes, create an SCSS file:

$llms-css-prefix: my-prefix-fa;
@import '@lifterlms/fontawesome/src/fontawesome';

The $llms-css-prefix variable allows creation of the Font Awesome CSS file in a "no-conflict" mode using a different prefix than the default fa prefix commonly used with Font Awesome. The default prefix, llms-fa is used by the LifterLMS core plugin. Any other projects should choose a unique prefix in order to avoid conflicts with other plugins (or LifterLMS) which may be loading various other versions of Font Awesome.

Then add an entry to your webpack config file, if you're using @lifterlms/scripts/config/webpack.config.js:

const { resolve } = require( 'path' ),
	config = generate( {} );

config.entry.fontawesome = resolve( './src/scss/fa-file.scss' );

module.exports = config;

When building you'll now find the Font Awesome CSS file at assets/css/fa-file.scss and the assets/fonts directory will contain copies of the Font Awesome font files.

Using SVGs

The above steps enable using Font Awesome as a webfont. If you wish to instead use SVGs, you may wish to copy the SVGs to your project's directory. The svg script can be used to copy the source SVGs into you project.

node ./node_modules/@lifterlms/fontawesome/bin/svg.js [destDir]    

The destDir parameter defaults to ./src/img/fontawesome if omitted.

Component and API Docs

getMetadata

Retrieves metadata for a given icon.

Parameters

  • iconId string: The icon ID.

Returns

  • IconMeta|boolean: An icon metadata object or false if the icon can't be found.

Icon

Renders a Font Awesome icon.

Parameters

  • props Object: Component properties.
  • props.icon string: The Icon ID.
  • props.iconStyle string: The icon style, enum: "solid", "regular", or "brands".
  • props.iconPrefix string: The project's icon prefix.
  • props.label string: The (optional) accessibility label to display for the icon.
  • props.wrapperProps ...Object: Any remaining properties which are passed to the icon wrapper component.

Returns

  • WPElement: The component.

IconPicker

Renders an icon picker component, intended to be used within the WordPress block editor.

Parameters

  • props Object: Component properties.
  • props.icon string: The Icon ID.
  • props.iconStyle string: The icon style, enum: "solid", "regular", or "brands".
  • props.iconPrefix string: The project's icon prefix.
  • props.controlProps Object: Properties to pass through to the component.
  • props.onChange Function: Function called when an icon is selected from the picker. The function is passed three properties: The icon ID, the currently selected style, and the icon's predefined label.

Returns

  • BaseControl: A BaseControl containing the icon picker component.