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

@andersonalmeidax0/appframe

v0.2.0

Published

appFrame

Downloads

13

Readme

Appframe

ReactComponent para aplicações com funcionalidades:

  • header (with login name and logout button)
  • menu for navigation
  • render subcomponents (pages) for each menu item
  • appContext singleton instance is passed through routes, to provide application context
  • Login Handler & JWT generator (keycloak)

how to use:

  1. Create index.html
  2. Create App using AppFrame.
    • App can initialize keycloack however its not mandatory
  3. Pass "routes", appname, appcontext,
  4. Create pageComponents (and include it)

Step 1:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>App</title>

    <title></title>
    <style>
        body { margin:0px}
        main { margin:8px}
	header { margin:0px;background-color: #ccc;}
	nav { margin:0px;background-color: #eee; }   
        </style>


  </head>
  <body id="main">
    <script type="module" src="/app.jsx"></script>
  </body>
</html>

Step 2a - app.jsx :Example "routes": labels, links and components for navigation

import pages...
var routes = [
  {"route":"/index.html#page1","label":"PageNotes", "component":Page1},
  {"route":"/index.html#page2","label":"PageNotes2", "component":Page2},
  {"route":"/index.html#page3","label":"PageTestComps", "component":PageTestComps},
  ]

Step 2aa Example appContext

let kc = {tokenParsed:{email:"noLogon@nologon"}, logout(){alert("Fake logout")}}
class AppContext {
  constructor(kc){
    this.kc=kc;
  }  
}

Step 2b

 <AppFrame routes={routes}  appContext={appContext}  appname='AppTest1'  />

Step 3:Example PageComponent

class Page1 extends React.Component{
        constructor(props){
        super(props);
    		this.state ={}
        }
   render() {
        return ( <React.Fragment>...)
      }
}

Step 4: Keycloack login&reload handler

Handle automatic redirect do keyclock to handle app browser autentication and JWT token generation

kc global variable: contains kc.token (JWT)

//versions:
//"keycloak-js": "^24.0.4",
//"react": "^18.2.0",
//To logout:  kc.logout({ redirectUri: 'http://apphost:port/' }

import Keycloak from 'keycloak-js';

let initOptions = {
  url:'kc url',
  realm: 'realm',
  clientId: 'client',
}
const kcInitParams = {
  onLoad: 'login-required',
  checkLoginIframe: true,
  pkceMethod: 'S256',
};

let kc = new Keycloak(initOptions);

kcInitDefaults(kc, kcInitParams);

Step 5: deps setup

{
  "dependencies": {
    "@andersonalmeidax0/appframe": "^0.1.1",
    "@vitejs/plugin-react": "^4.0.0",
    "react": "^18.0.1",
    "react-dom": "^18.0.1",
    "react-scripts": "4.0.3",
    "vite": "^4.3.3"
  },
  "scripts": {
    "dev": "vite --port 8081",
    "build": "vite build",
    "preview": "vite preview"
  }
}

Step 6: vite setup: vite.config.js ==> "npm run dev" to test

import { defineConfig } from 'vite';
import path from 'path'

import react from '@vitejs/plugin-react';

export default defineConfig({
  root: 'src',
  build: {
    outDir: '../_dist'
  },   
  plugins: [react()],
  esbuild: {
    jsxFactory: 'React.createElement',
    jsxFragment: 'React.Fragment',
  },
  css: {
    modules: {
      localsConvention: 'camelCaseOnly',
    }
  }
});

Complete app.jsx

import React from "react";
import ReactDOM from 'react-dom/client';
import {AppFrame} from '@andersonalmeidax0/appframe';


class App extends React.Component {
    render() {
      return (
        <div>
          <h1>Hello, world v3!</h1>
        </div>
      );
    };
}    

//Not used (simple example)
class Page1 extends React.Component {
    render() {
      return (
        <div><h1>Page1 v2</h1></div>
      );
    };
} 

let kc = {tokenParsed:{email:"[email protected]"}, logout(){alert("Fake logout")}}
class AppContext {
 constructor(kc){
 this.kc=kc;
 }
}
var appContext = new AppContext(kc);

var routes = [
{"route":"/index.html#page1","label":"Page1", "component":Page1},
{"route":"/index.html#page2","label":"Page2", "component":Page1}
];

class App2 extends React.Component {
    render() {
      return (
       <AppFrame routes={routes}  appContext={appContext}  appname='AppTest1v23'  />
      );
    };
} 


const root = ReactDOM.createRoot(document.getElementById('main'));
root.render(<App2 />);