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

flamingo-carotene-behavior

v9.0.0-alpha.13

Published

The behavior module enables to initialize javascript behaviors on html elements

Downloads

36

Readme

Module flamingo-carotene-behavior

The behavior Module is a "DOM-aware" component loader, which loads js-classes automatically and attaches them to dom-elements.

How to use

npm i -D flamingo-carotene-behavior

See 'How to initialize' below.

What it is for

Given, you've got a DOM structure like this:

<div>
    <h1>Click here to see the collapsible content</h1>
    <div class="content">Content of the collapsible</div>
</div>

And you want to add some javascript behavior to the headline element to toggle visibility of the content element.

Simply add "data-behavior"-attribute to the element group

<div data-behavior="collapsible">
    <h1>Click here to change the collapsible content</h1>
    <div class="content">Content of the collapsible</div>
</div>

After that, create an ES6 class with the name of the data-attribute (in that case "collapsible")

export default class Collapsible {

  constructor (element) {
    // your code here
  }

  dispose () {
    // your code here
  }
}

Note: The NAME of the class is important here! The DOM element with the data-behavior attribute is passed to the constructor of your class.

How to initialize

Initialisation is easy.

Load the behavior module

import Behavior from 'flamingo-carotene-behavior'

Loading your behaviors

  • Load all your behaviors with globbing (the babel-way)
import * as behaviorModules from './../../**/*.behavior.js'
  • Load all your behaviors with globbing (the webpack-way)
import behaviorModules from './../../**/*.behavior.js'
  • Load all your behaviors manually
import myBehavior from './foo/bar/myBehavior.js'
import anotherBehavior from './xxx/yyy/anotherBehavior.js'
const behaviorModules = {
  'myBehavior': myBehavior,
  'anotherBehavior': anotherBehavior
}

Create a behavior instance and pass your behaviors to the constructor

const behavior = new Behavior(behaviorModules)
behavior.attachBehaviors() 

Done!

Debugging

If you've got strange results or behaviors of the behavior module, it is worth to turn on debugging console messages. Simply add

behavior.setDebug(true)

after creating the behavior instance.