npmpackage.info

@hotwired/stimulus

A modest JavaScript framework for the HTML you already have

3.2.2

12,734

MIT

TypeScript

10.88 kB

43,507,806 4.2

Installations

npm install @hotwired/stimulus

Pull Requests

Open

28

Total

339

Closed

67

Merged

244

Issues

Open

55

Total

452

Closed

397

Releases

v3.2.2

Published on 07 Aug 2023

v3.2.1

Published on 30 Nov 2022

v3.2.0

Published on 28 Nov 2022

v3.1.1

Published on 31 Oct 2022

v3.1.0

Published on 18 Jul 2022

v3.0.1

Published on 07 Oct 2021

View all 17 releases

Developer

hotwired

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

16.15.0

NPM Version

8.5.5 Statistics

12,734 Stars

1,127 Commits

426 Forks

198 Watching

14 Branches

92 Contributors

Updated on 28 Nov 2024

Bundle Size

45.03 kB

Minified

10.88 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (98.03%)

JavaScript (1.97%)

Total Downloads

Cumulative downloads

Total Downloads

43,507,806

Last day

-8.9%

73,786

Compared to previous day

Last week

3.9%

423,247

Compared to previous week

Last month

2.5%

1,760,713

Compared to previous month

Last year

20.6%

19,437,240

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Stimulus

A modest JavaScript framework for the HTML you already have

Stimulus is a JavaScript framework with modest ambitions. It doesn't seek to take over your entire front-end—in fact, it's not concerned with rendering HTML at all. Instead, it's designed to augment your HTML with just enough behavior to make it shine. Stimulus pairs beautifully with Turbo to provide a complete solution for fast, compelling applications with a minimal amount of effort.

How does it work? Sprinkle your HTML with controller, target, and action attributes:

1<div data-controller="hello">
2  <input data-hello-target="name" type="text">
3
4  <button data-action="click->hello#greet">Greet</button>
5
6  <span data-hello-target="output"></span>
7</div>

Then write a compatible controller. Stimulus brings it to life automatically:

1// hello_controller.js
2import { Controller } from "@hotwired/stimulus"
3
4export default class extends Controller {
5  static targets = [ "name", "output" ]
6
7  greet() {
8    this.outputTarget.textContent =
9      `Hello, ${this.nameTarget.value}!`
10  }
11}

Stimulus continuously watches the page, kicking in as soon as attributes appear or disappear. It works with any update to the DOM, regardless of whether it comes from a full page load, a Turbo page change, or an Ajax request. Stimulus manages the whole lifecycle.

You can write your first controller in five minutes by following along in the Stimulus Handbook.

You can read more about why we created this new framework in The Origin of Stimulus.

Installing Stimulus

You can use Stimulus with any asset packaging systems. And if you prefer no build step at all, just drop a <script> tag on the page and get right down to business.

See the Installation Guide for detailed instructions.

Getting Help

Looking for the docs? Once you've read through the Handbook, consult the Stimulus Reference for API details.

Have a question about Stimulus? Connect with other Stimulus developers on the Hotwire Discourse community forum.

Contributing Back

Find a bug? Head over to our issue tracker and we'll do our best to help. We love pull requests, too!

We expect all Stimulus contributors to abide by the terms of our Code of Conduct.

Development

Fork the project locally
yarn install
yarn start - to run the local dev server with examples
yarn test - to run the unit tests
yarn lint - to run the linter with ESLint
yarn format - to format changes with Prettier

Acknowledgments

Stimulus is MIT-licensed open-source software from Basecamp, the creators of Ruby on Rails.

Continuous integration VMs generously provided by Sauce Labs.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

7

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

5

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.2

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @hotwired/stimulus

@csedl/stimulus-initializer

1.0.27

Initializer for Hotwired/Stimulus

@hotwired/stimulus-webpack-helpers

1.0.1

Webpack helpers for Stimulus.

@mguidetti/stimulus-components

1.1.0

[Stimulus](https://github.com/hotwired/stimulus) components used in my projects. Free to use and contributions welcome.

stimulus-use

0.52.2

A collection of standard controllers and utilities for Stimulus

@hotwired/stimulus

Installations

Pull Requests

28

339

67

244

Issues

55

452

397

Releases

Developer

Developer Guide

CommonJS

Yes

16.15.0

8.5.5

Statistics

Bundle Size

45.03 kB

10.88 kB

Languages

Total Downloads

43,507,806

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

Stimulus

A modest JavaScript framework for the HTML you already have

Installing Stimulus

Getting Help

Contributing Back

Development

Acknowledgments

10

10

10

9

7

5

0

0

0

0

0

0

0

4.2

/10

Other packages similar to @hotwired/stimulus