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

@tedwin007/widgets

v0.1.7

Published

Please check out the playground: [Playground](https://main--friendly-sunburst-260760.netlify.app/) ![Site](src/lib/assets/site.png?raw=true "Site") To get more insight about creating new widgets, schema validation and process Or see some basic code implem

Downloads

5

Readme

Widget Manager

Please check out the playground: Playground Site To get more insight about creating new widgets, schema validation and process Or see some basic code implementation in the playground's github repository [WIP]

This is a TypeScript library for managing the lifecycle of widgets including:

  • Creation
  • Validation
  • Serialization
  • Rendering

Features

  • Create widget instances from JSON with validation.
  • Serialize widget instances to JSON.
  • Attach render methods to widget instances for UI rendering.
  • Support for custom schemas during widget creation.
  • Built-in error handling and logging.

Installation

npm install @tedwin007/widgets --save

Or if you are using yarn:

yarn add @tedwin007/widgets

Usage

Import WidgetManager and Widget into your project:

import {WidgetManager, Widget} from '@tedwin007/widgets';

Instantiate & validate a widget

const widgetManager = new WidgetManager();
const widgetJson = {
    id: 'widget-123',
    version: '1.0.0',
    config: {
        theme: 'light',
        layout: 'fixed'
    },
    data: {
        title: 'My Widget',
        content: 'This is my widget content'
    },
    widgetProps: {
        title: 'My Partial Widget'
    },
};
const myWidget = widgetManager.fromJson(widgetJson); 

Validating and Rendering a Widget

this.widgetManger
    .fromJson(this.rawWidget, WidgetSchema.Existing)
    .attachRender(this, (element) => element.innerHTML = `<h1>Widget Content</h1>`)
    .render()

Serializing a Widget to JSON

const widgetToJson = widgetManager.toJson(myWidget);
console.log(widgetToJson);

API

WidgetManager

  • fromJson(widget: BaseWidget, schema: WidgetSchema, customSchema?: object): FromJsonResponse
  • toJson(widget: Widget): ToJsonResult

Widget

  • setData(data: T): void
  • toJson(): ToJsonResult
  • render(): void

For detailed API usage, please refer to the inline documentation within the code.

Development

  • Clone the repository.
  • Install dependencies using npm install.
  • Build the project using npm run build.

Publish

npm publish --access public

This will automatically do the following before publishing the package to npm repository:

  • lint & fix code-style
  • run tests
  • bump version
  • build & pack