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

mastodon-widget

v0.2.1

Published

Mastodon Widgets as Web Components

Downloads

2,093

Readme

Mastodon Widgets

This is a collection of Mastodon widgets for use on websites to add share and follow buttons and to display a user's profile and timeline.

🌟 If you like it, please star the repo and share it on Mastodon.

Usage

Here's the basic usage: Add the script tag to your <head> and then use any of the available components in your HTML.

<html lang="en">
  <head>
    <script type="module" src="https://unpkg.com/mastodon-widget"></script>
  </head>
  <body>
    <mastodon-widget account="[email protected]" limit="5"></mastodon-widget>

    <mastodon-share text="What a cool idea!"><button>Share this!</button></mastodon-share>
  </body>
</html>

The script will lazy load only the components you actually use.

Components

You can see a demo of the available components at https://splitbrain.github.io/mastodon-widget/ and read more about them in their respective readme files:

Development

The widgets are web components built with the StencilJS compiler.

Setup dependencies:

npm install

Start a development server:

npm run start

Build the components and update the readme files for production:

npm run build

Prettify the code:

npm run pretty

NPM Package

The project is published to npm as mastodon-widget. See the npm page for more info.

For building a new release, run:

npm version patch
git push
git push --tags

Replace patch with minor or major as needed. This will update the pakage version, create a git tag and push it to the repo. There a github action will build the package and publish it to npm.

Help

Please help with the open issues.

This is my first project using stenciljs and typescript, so I'm sure there is a lot of room for improvement. Pull requests are welcome.