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

@nypl/dgx-react-footer

v0.5.8

Published

NYPl React Footer

Downloads

26

Readme

NYPL Footer

This repository is the footer component for the ReactJS applications of nypl.org.

Version

0.5.8

App Installation

To install this module, run:

$ npm install --save @nypl/dgx-react-footer

This component is a scoped NPM module. This means that when installing, NPM will create a @NYPL folder and the dgx-react-footer component (and other NYPL scoped components) will be there.

Usage

Import using ES6 style syntax:

// Application.jsx
import Footer from '@nypl/dgx-react-footer';

Import using ES5 style syntax:

// Application.jsx
var Footer =  require('@nypl/dgx-react-footer');

Call the instance in your application component:

<Footer id="footer" className="footer" />

Component Props

  • urlType: Type of URL's to be established for NYPL link elements. If empty, it will utilize relative URL's by default. If absolute URL's are required, such as for apps that live at a different domain, initialize the Footer component as follows:
  <Footer urlType='absolute' /> // Sets all URLs to absolute
  <Footer /> // Sets all URLs to relative

Styles

You can write your own styles for the footer but we suggest you use the styles that come in the package. It's written in SASS and to import we use the Webpack syntax in SASS:

// app.scss
@import "~@nypl/dgx-react-footer/dist/styles/styles.scss";

Local Installation

Install all dependencies listed under package.json

$ npm install

Development Mode

We use Webpack to fire off a hot-reloading development server. This allows for continuous code changes without the need to refresh your browser.

This starts the server at localhost:3000 defaulting to NODE_ENV=development.

$ npm start

Production Mode

To build the component and serve the minified files, run the following two commands. Setting the NODE_ENV flag to production triggers the production environment.

$ npm run babel-build
$ NODE_ENV=production npm start

Contribute

  1. Fork this repo.
  2. Create a feature branch - git checkout -b new-feature.
  3. Commit your changes - git commit -am 'Description of feature'.
  4. Push the branch - git push origin new-feature.
  5. Create a new Pull Request.

Contributors

NYPL Digital Experience