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

@i-vresse/haddock3-ui

v0.3.1

Published

[![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)](https://github.com/i-VRESSE/haddock3-ui) [![npmjs.com](https://img.shields.io/npm/v/@i-vresse/haddock3-ui.svg?style=flat)](https://www.npmjs.co

Downloads

16

Readme

React components for/from haddock3 webapp

github repo badge npmjs.com CI lint CI test codecov DOI Research Software Directory Badge fair-software.eu Checked with Biome

The haddock3 web application had several components that could be used outside of the web application. This package contains those components.

  • Components to render a 3D molecular structure from PDB file using NGL
  • Components to select residues in a molecule either passive or active
  • Components to handle files
  • Components to render clusters or structures in a sortable table

Installation

npm install @i-vresse/haddock3-ui

The components are styled with tailwindcss. For your own webapp to pick up the classes in the components, you need to add the following to your tailwind.config.js:

/** @type {import('tailwindcss').Config} */
export default {
  content: [
    // Existing content goes here
    './node_modules/@i-vresse/haddock3-ui/dist/**/*.js',
  ],
  // Rest of the config goes here
}

If you are not using tailwindss, you can make use the included css file import "@i-vresse/haddock3-ui/dist/index.css" (based on New York neutral shadcn/ui theme).

Usage

Stories of the components can be found at https://i-VRESSE.github.io/haddock3-ui.

See the sidebar for a list of all component stories. Once component is selected

  • interact with component story
  • use </> button in footer to see the code.
  • use sliders icon button in footer to change props when available

API documentation is available at https://i-VRESSE.github.io/haddock3-ui/api/

Direct in browser

The components can be used directly in the browser, without your own build system.

example.html is a clustered table example which uses the latest package version from npm via https://esm.sh/. example-molviewer.html is a simple molecule viewer example.

Offline bundle

The table components are used by the caprieval module of haddock3 to generate report.html. Haddock3 can be used offline, which means after installation the running of haddock3 will be isolated from the Internet.

To use the table components offline, you can build an offline bundle of the components with

# Installs dependencies
pnpm install
# Create dist/index.css and dist/report.bundle.js,
# which contains the table components and all of its dependencies
pnpm build

See example-offline.html for an example of how to use the offline version.

To prevent CORS issues, the html, css and js files should be served from the same http server like with python3 -m http.server and visit http://localhost:8000/example-offline.html.