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

@mobility-platform/global-navigation

v5.2.3

Published

The Global Navigation is part of the Michelin Mobility Platform. The navigation is used to travel between Mobility Platform applications and can be used on any website.

Downloads

9

Readme

Global Navigation

The Global Navigation is part of the Michelin Mobility Platform. The navigation is used to travel between Mobility Platform applications and can be used on any website.

Installation

This package can be installed with any package manager

npm i @mobility-platform/global-navigation

or

yarn add @mobility-platform/global-navigation

If you don't want to use a package manager and only want to include the Global Navigation as a script, you can import the UMD version at the end of the body tag:

<body>
  <!-- ... -->
  <script src="https://unpkg.com/@mobility-platform/global-navigation" async></script>
</body>

Usage

After adding the package, you can render the global navigation in you application. The Global Navigation is a vertical navigation bar fixed on the left of the screen, visible all the time. You should prepare a 60px padding to the left of your app to avoid content going behind the Global Navigation.

import { verticalNavigation } from "@mobility-platform/global-navigation";

verticalNavigation.render({
  selector: '[data-widget-host="what-you-want"]', //DOM Element selector
  defaultProps: {
    // `getToken` is a function returning a Promise resolving with an authentication token or rejecting if the user is not authenticated
    getToken,

    // The Global Navigation `configurationUrl`. You may want to change this depending on the application environment (e.g.: staging or production)
    // Use https://unpkg.com/@mobility-platform/global-navigation-configuration/development.config.json for development / staging,
    // and https://unpkg.com/@mobility-platform/global-navigation-configuration/production.config.json for production
    configurationUrl:
      "https://unpkg.com/@mobility-platform/global-navigation-configuration/development.config.json"

    // (Optional) `loginUrl` is the URL used when the user is not authenticated to the Mobility Platform.
    // In this case, a login button can be added to the Global Navigation
    loginUrl: "https://my-app.com/login",

    // (Optional) `preferredLanguage` a 2-letters language ISO code for Global Navigation translations.
    // This will fallback to the navigator language.
    preferredLanguage: "fr",
  }
});

or if you are using the UMD version:

<script>
  window.globalnavigation.verticalNavigation.render({
    selector: '[data-widget-host="what-you-want"]', //DOM Element selector
    defaultProps: {
      // Same as the previous example
    },
  });
</script>

More information about the Mobility Platform can be find here : https://mobility-platform-docs.netlify.com/getting-started

Examples

Vertical Navigation with React

https://codesandbox.io/s/mobility-platformglobal-navigation-react-9y9j9

Vertical Navigation in Vanilla JS

https://codesandbox.io/s/mobility-platformglobal-navigation-vanilla-js-wywym

License

Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)