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

twp-login-component

v1.1.16

Published

A component to hold a user's state and display an element based on that state and data-attributes

Downloads

22

Readme

Login Component (TWP LC)

A JS library & components that determine a user's state. It's goal is to replace TWP's login entries to house logic in a single location. This project is broken into two parts: react and vanilla components.

Entry Points

  • Vanilla: src/vanilla/Login/index.js and src/index.html is where the element is added to run locally.
  • React: src/fusion/Login/index.js and src/fusion/index.html is where the app root element is.

Running Locally

  • Url: http://localhost.digitalink.com:9000
  • Vanilla: start:vanilla:dev
  • React: start:fusion:dev

Integration

  • Vanilla
    • Add dist/lib/login.min.js file into page's <head>...</head> using a script tag and add <div class="_twp_login-component"></div> to markup for component to be rendered.
    • When window.TWPLC is available, call new window.TWPLC({ env: "dev", name: "acquistion" }).init() to render elements.
  • React
    • Add <Login {...props} /> component after importing (import {Login} from 'twp-auth-component').
    • LoginState is exported too, you can use import {LoginState} from 'twp-login-component' to use its' functions.
      • ex: new LoginState({ env: "dev", name: "fusion:navigationContext" })

Element options

If you are using vanilla component, use data-${option}=${value}. If use react component pass as props.

If overriding default text with data-text or text={} (React), {{displayName}} can be passed in the signedIn value. It will replaced with LoginState.getUsername return value.

| Name | Values | Default | Description | | ---- | ------ | ------- | ----------- | | display | ["button", "link"] | "button" | none | | text | { "signedIn": "Sign me out, now!", "signedOut": "Oh, let's sign you in!"} | {signedIn: 'Sign out', signedOut: 'Sign in'} | This needs to be a valid JSON string if not using React, or it'll revert back to default | | align | ["left", "center", "right"] | "left" | none | | styles | {} | {} | Override the button or a tag's default style (<button> or <a>) | | nestedStyles | {} | {} | Override the innerHTML inside parent tag (<span>) | | overlay | [true, false] | false | Display USW in overlay | | callback | Function | undefined | Pass a callback, by default will redirect or pop-up modal |

Props (React)

| Name | Values | Default | Description | | ---- | ------ | ------- | ----------- | | buttonClasses | "" | "" | Can be used as override class properties | textClasses | "" | "" | Can be used as override class properties

Deploying

Once pushed to master branch, Jenkins will run ./scripts/pkg.sh to test, build and publish to npm repository.