This article was originally published on Rails Designer
To me the most beautiful thing about using Stimulus controller is have them to small, specific things. You don't create a big controller for one component, but create multiple smaller Stimulus controller that are all do their own little thing. And when you need some more cohesion, you can use outlets to have them “talk together”.
But if you you need another Stimulus controller that has logic that overlaps with another, you can do two things:
- extract the logic into separate functions that you import; or,
- use inheritance to gain the logic from the other controller.
Inheritance is what I want to explore today. Recently I added a bulk actions component to the UI component library. This allows users to select multiple items from a list and they apply the same action to them all, eg. Delete All. This has quite some overlap with the checkboxes component. Both needed the exact same logic to select items. For the Bulk Actions, selecting the items was the start; it would then show the "action bar" with a counter.
(see original article for the moving gif! ?)
Note: This article is not about adding bulk actions from start to finish! For that I suggest to check out Rails Designer (it also has hundreds of components ready to use in your Rails SaaS app).
First let's see the checkboxes_controller.js (the one included with Rails Designer is a bit more involved!).
// app/javascript/controllers/checkboxes_controller.js import { Controller } from "@hotwired/stimulus"; export default class extends Controller { static values = { checkboxesCheckedCount: Number }; selectAll() { this.setCheckboxesTo(true); } deselectAll() { this.setCheckboxesTo(false); } setCheckboxesTo(boolean) { const checkboxes = this.checkboxes .filter(checkbox => !checkbox.disabled) .forEach(checkbox => checkbox.checked = boolean); this.checkboxesCheckedCountValue = checkboxes.length; } // … }
I think this is simple enough to follow, right? Then the bulk_actions_controller.js:
// app/javascript/controllers/bulk_actions_controller.js import CheckboxesController from "controllers/checkboxes_controller"; export default class BulkActionsController extends CheckboxesController { static values = { open: Boolean }; // private checkboxesCheckedCountValueChanged() { this.openValue = this.checkboxesCheckedCountValue; } }
Quick run down of the code: when the checkboxesCheckedCountValue changes (which is a value of checkboxes_controller) set the openValue (0 is false, everything else is true). Easy enough! The openValue is then used to show/hide the actions bar.
You can see it doesn't inherit from Controller, but from CheckboxesController that is imported on the 2nd line (instead of the typical import { Controller } from "@hotwired/stimulus";).
But as it currently is written, this won't be enough. The checkboxes_controller isn't actually correctly exported. Let's do that first:
import { Controller } from "@hotwired/stimulus"; // Was: `export default class extends Controller {` export default class CheckboxesController extends Controller { // … }
So how does this work? For Ruby (and Rails) you can inherit from another class like so:
class User < ApplicationRecord class Integration::Netlify < Integration::Base # etc.
Rails, or more specifically Zeitwerk, autoloads the classes for you, so above would just work. With a typical Ruby app, classes aren't auto-loaded either and you need to do it manually.
require "application_record" require "integration/base" # etc.
That's similar to how JavaScript works.
The way you are used to write Stimulus controllers (export default class extends Controller) is by creating an anonymous class that extends the Stimulus Controller (akin to class < Integration::Base). The checkboxes_controller is now a named class that extends the Stimulus Controller.
Now that can be imported without issues in bulk_actions_controller. And that's how it can inherit the functions and all other logic (this.checkboxesCheckedCountValue) from the checkboxes_controller. Keep in mind that private functions (the ones starting with a #) cannot be used in other JavaScript classes, which is different from Ruby classes!
When to use inheritance for Stimulus controllers
I don't reach for inheritance all that much. More often I extract the logic into its own function in another file and import that instead (like Ruby's include or extend). But sometimes when there is 100% overlap with the other controller's logic and I don't have to make changes to the other controller, inheritance is a lovely and clean option.
So to summarize:
- make the other class importable export default class CheckboxesController extends Controller;
- then import the class in the other controller import CheckboxesController from "controllers/checkboxes_controller";;
- then extend the other controller using the imported controller export default class BulkActionsController extends CheckboxesController {}.
You can see the syntax is pretty similar to Ruby, but more verbose (but that's really unique about Ruby!).
? I am planning to release a book: JavaScript for Rails Developers. Well over 50 people already pre-ordered it. Will you be next? ??
The above is the detailed content of Inheritance with Stimulus Controller. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

JavaScript's garbage collection mechanism automatically manages memory through a tag-clearing algorithm to reduce the risk of memory leakage. The engine traverses and marks the active object from the root object, and unmarked is treated as garbage and cleared. For example, when the object is no longer referenced (such as setting the variable to null), it will be released in the next round of recycling. Common causes of memory leaks include: ① Uncleared timers or event listeners; ② References to external variables in closures; ③ Global variables continue to hold a large amount of data. The V8 engine optimizes recycling efficiency through strategies such as generational recycling, incremental marking, parallel/concurrent recycling, and reduces the main thread blocking time. During development, unnecessary global references should be avoided and object associations should be promptly decorated to improve performance and stability.

There are three common ways to initiate HTTP requests in Node.js: use built-in modules, axios, and node-fetch. 1. Use the built-in http/https module without dependencies, which is suitable for basic scenarios, but requires manual processing of data stitching and error monitoring, such as using https.get() to obtain data or send POST requests through .write(); 2.axios is a third-party library based on Promise. It has concise syntax and powerful functions, supports async/await, automatic JSON conversion, interceptor, etc. It is recommended to simplify asynchronous request operations; 3.node-fetch provides a style similar to browser fetch, based on Promise and simple syntax

JavaScript data types are divided into primitive types and reference types. Primitive types include string, number, boolean, null, undefined, and symbol. The values are immutable and copies are copied when assigning values, so they do not affect each other; reference types such as objects, arrays and functions store memory addresses, and variables pointing to the same object will affect each other. Typeof and instanceof can be used to determine types, but pay attention to the historical issues of typeofnull. Understanding these two types of differences can help write more stable and reliable code.

Hello, JavaScript developers! Welcome to this week's JavaScript news! This week we will focus on: Oracle's trademark dispute with Deno, new JavaScript time objects are supported by browsers, Google Chrome updates, and some powerful developer tools. Let's get started! Oracle's trademark dispute with Deno Oracle's attempt to register a "JavaScript" trademark has caused controversy. Ryan Dahl, the creator of Node.js and Deno, has filed a petition to cancel the trademark, and he believes that JavaScript is an open standard and should not be used by Oracle

Which JavaScript framework is the best choice? The answer is to choose the most suitable one according to your needs. 1.React is flexible and free, suitable for medium and large projects that require high customization and team architecture capabilities; 2. Angular provides complete solutions, suitable for enterprise-level applications and long-term maintenance; 3. Vue is easy to use, suitable for small and medium-sized projects or rapid development. In addition, whether there is an existing technology stack, team size, project life cycle and whether SSR is needed are also important factors in choosing a framework. In short, there is no absolutely the best framework, the best choice is the one that suits your needs.

IIFE (ImmediatelyInvokedFunctionExpression) is a function expression executed immediately after definition, used to isolate variables and avoid contaminating global scope. It is called by wrapping the function in parentheses to make it an expression and a pair of brackets immediately followed by it, such as (function(){/code/})();. Its core uses include: 1. Avoid variable conflicts and prevent duplication of naming between multiple scripts; 2. Create a private scope to make the internal variables invisible; 3. Modular code to facilitate initialization without exposing too many variables. Common writing methods include versions passed with parameters and versions of ES6 arrow function, but note that expressions and ties must be used.

Promise is the core mechanism for handling asynchronous operations in JavaScript. Understanding chain calls, error handling and combiners is the key to mastering their applications. 1. The chain call returns a new Promise through .then() to realize asynchronous process concatenation. Each .then() receives the previous result and can return a value or a Promise; 2. Error handling should use .catch() to catch exceptions to avoid silent failures, and can return the default value in catch to continue the process; 3. Combinators such as Promise.all() (successfully successful only after all success), Promise.race() (the first completion is returned) and Promise.allSettled() (waiting for all completions)

CacheAPI is a tool provided by the browser to cache network requests, which is often used in conjunction with ServiceWorker to improve website performance and offline experience. 1. It allows developers to manually store resources such as scripts, style sheets, pictures, etc.; 2. It can match cache responses according to requests; 3. It supports deleting specific caches or clearing the entire cache; 4. It can implement cache priority or network priority strategies through ServiceWorker listening to fetch events; 5. It is often used for offline support, speed up repeated access speed, preloading key resources and background update content; 6. When using it, you need to pay attention to cache version control, storage restrictions and the difference from HTTP caching mechanism.
