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

@chapeaux/cpx-user

v0.8.5

Published

Chapeaux User Component

Downloads

782

Readme

CPX-USER

PURPOSE

The cpx-user component is meant to be a centralized location for user-related information and functionality.

Installation

  • npm install @chapeaux/cpx-user or consume from a CDN via @chapeaux/cpx-user
  • include the cpx-user.js file on a page prior to any event tracking that should occur

Events

  • user-ready - fires when the .user object data is populated
  • user-update - fires when the .user object is updated

Usage

User data is always stored on the .user property once it is available.

  • Server-side or on-page

    Server-side Data inclusion example

    ```html
    <cpx-user>
        <script type="data">
        {
            "name": "Test User",
            "email": "[email protected]"
        }
        </script>
    </cpx-user>
    ```
  • JSON Web Token

    Requires that jwt_decode library be available globally.

    Available component properties:

    • jwt-cookie: sets the cookie to parse for JWT data
    • jwt-token: sets the JWT token to parse for data

    JWT Cookie Example

    ```html
    <cpx-user jwt-cookie="SOME_JWT_COOKIE_NAME"></cpx-user>
    ```

    JWT Token

    ```html
    <cpx-user jwt-token="SOMEJWTENCODEDSTRING"></cpx-user>
    ```

Usage

  • <script type="module" src="path/to/@chapeaux/cpx-websocket/cpx-websocket.js"></script>
  • import { CPXWebSocket } from "path/to/@chapeaux/cpx-websocket/cpx-websocket.js";
  •  <cpx-websocket id="leaderboard" url="ws://localhost:8080/leaderboard">
         <template>
         <h1 data-key="length">Top ${data.length}</h1>
         <ol>
         <li data-repeat="data"><a href="/${gameId}" onclick="return false;">${userName}</a>.....${score}</li>
         </ol>
         </template>
     </cpx-websocket>
    

Testing

  • deno test runner and assertions: https://deno.land/manual/testing/assertions

Contributing

  1. Provide feedback on usage
  2. Submit an issue or PR
  3. Feature requests flow through CPCORE Jira Project
    • Use "chapeaux" component
    • Priority will be reviewed against all other requests
    • No timeframe promised upon submission

To-Do

  • Nothing at this time