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

@bionamic/component

v6.0.0

Published

Bionamic component library

Downloads

37

Readme

Bionamic component library

The library is used by the Bionamic application and implements basic components for the JC-Bn system. The JC side is responsible for handling state and actions. The Bn side is responsible for rendering the state and triggering actions from user interactions. Every component has an interface which defines what state and actions are needed to render the component. For components that implement a dedicated JC class, the interface object can be created using the helper "getI..." function. Some of the more basic components (which do not require any state) do not need a JC class, instead, conventient pure interface functions are provided.

Example: MyFirstComponent

Naming

The following is an example of how the different classes for a component should be named.

Interface

Interfaces are named by placing the component name after "I" (which stands for "Interface"). Example: IMyFirstComponent

Interfaces use functions both to get and set values and these functions are prefixed with "get" or "set". Examples: getValue(): () => string; setValue(): (value: string) => void;

JC

JC classes are named by placing the component name after "JC" (which stands for "Javascript Component"). Example: JCMyFirstComponent

The JC class provides an interface function named "getIMyFirstComponent" which returns an interface object (which fulfilles IMyFirstComponent) and can be used to render the corresponding Bn component.

Bn

Bn classes are named by placing the component name after "Bn" (which stands for "Bionamic"). Example: BnMyFirstComponent

Tags

The web component html tags are named by placing the component name (lowercased and split with "-") after "bn-" Example: <bn-my-first-component>

File structure

A component is defined inside a folder (named the lowercased component name, "myfirstcomponent" in this example) in the "src" directory. The folder contains an "interface.ts" file defining the JC-Bn interface and any necessary helper types. The "myfirstcomponent" folder also contains a "jc" folder (containing the JC class and any helper logic) and a "bn" folder (containing the Bn class written as a Lit component).