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

crds-shared-header

v0.7.3

Published

`crds-shared-header` is a framework-agnostic implementation of Crossroads' global header.

Downloads

4

Readme

crds-shared-header

crds-shared-header is a framework-agnostic implementation of Crossroads' global header.

Requirements

This project requires the following dependencies...

Usage

Install this package via NPM by executing the following command in your project directory...

npm install crds-shared-header --save

Include the compiled bundle before the closing <body> tag in your HTML like this...

<script src="./node_modules/crds-shared-header/dist/bundle.js"></script>

The header class will be available on the global CRDS object. Instantiate and render like so...

<script>
(function(){
  var options = { el: '[data-header]' };
  var header = new CRDS.SharedHeader(options);
      header.render();
})();
</script>

The following options can be passed when the object is instantiated...

| Options | Description | Default | | -------- | ------ | ------- | | el | Selector to bind the rendered header to | [data-header] | | contentBlockTitle | The title of the contentBlock used to populate the navigation | sharedGlobalHeader | | contentBlockCategories | Defines category containing contentBlockTitle | ['common'] | | userMenuContentBlockTitle | The title of the contentBlock used to populate a signed-in user's menu | sharedGlobalHeaderUserMenu | | userMenuContentBlockCategories | Defines category containing userMenuContentBlockTitle | ['common'] | | cmsEndpoint | Environmentally specific URL to the CMS | https://contentint.crossroads.net/ | | appEndpoint | URL prepended to the sign-in button | https://int.crossroads.net/ | | imgEndpoint | URL prepended to the user avatar images | https://gatewayint.crossroads.net/gateway/api/image/profile/ | | crdsCookiePrefix | prefix to prepend to environment's cookie names. int would be intsessionId | int |

Authentication

When a user logs into the site, the sign-in button at the right side of the menu should be replaced with their profile image and a dropdown menu containing account specific links. Currently, the script is configured to respond accordingly whenever a cookie named ${crdsCookiePrefix}sessionId is set for the current session.

document.cookie = 'intsessionId=21864538764'; //required
document.cookie = 'username=Sean'; // optional

Browser Support

In order to support IE versions 10 and 11, you'll need to include the following polyfills in your page/project...

License

This project is licensed under the 3-Clause BSD License.