How alpinejs/alpine works
Alpine.js is a lightweight, HTML-driven reactive UI framework, accompanied here by plugins, a CSP-safe evaluator, and accessible UI components. The primary workflow starts with markup in a browser: Alpine initializes the page, observes DOM changes, registers directives, evaluates their expressions against scoped data, and updates behavior and presentation reactively. Plugins add optional browser behaviors; the UI package provides higher-level components. Edges are limited to relationships shown in excerpts, source-index references, or README descriptions; unsampled modules are represented only where the tree or README supports their role.
Main entry points: alpine.js Alpine API · index.js Core setup · directives.js Directive system · mutation.js DOM mutation observer
Components 20
Alpine core
- Alpine API
packages/alpinejs/src/alpine.js - Core setup
packages/alpinejs/src/index.js - Directive system
packages/alpinejs/src/directives.js - Built-in directives
packages/alpinejs/src/directives/index.js - Expression evaluator
packages/alpinejs/src/evaluator.js - Data scopes
packages/alpinejs/src/scope.js - Magic properties
packages/alpinejs/src/magics.js - Reactivity engine
packages/alpinejs/src/reactivity.js
DOM runtime
- Tree lifecycle
packages/alpinejs/src/lifecycle.js - DOM mutation observer
packages/alpinejs/src/mutation.js - DOM cloning
packages/alpinejs/src/clone.js - Transitions
packages/alpinejs/src/directives/x-transition.js - Job scheduler
packages/alpinejs/src/scheduler.js
Alpine plugins
- Browser behavior plugins
packages
CSP evaluator
- CSP expression parser
packages/csp/src/parser.js - CSP evaluator
packages/csp/src/evaluator.js
UI components
- List context
packages/ui/src/list-context.js - Accessible controls
packages/ui/src
Other components
- HTML markup
- Browser user
Connections 24
- Browser user → HTML markup: interacts with
- HTML markup → Core setup: initializes
- Core setup → Alpine API: imports core
packages/alpinejs/src/index.js - Core setup → Built-in directives: registers
packages/alpinejs/src/index.js - Core setup → Expression evaluator: configures
packages/alpinejs/src/index.js - Core setup → Reactivity engine: configures
packages/alpinejs/src/index.js - Alpine API → Directive system: exposes
packages/alpinejs/src/alpine.js - Alpine API → Tree lifecycle: exposes
packages/alpinejs/src/alpine.js - Alpine API → DOM mutation observer: exposes
packages/alpinejs/src/alpine.js - Alpine API → Data scopes: exposes
packages/alpinejs/src/alpine.js - Directive system → Expression evaluator: evaluates with
packages/alpinejs/src/directives.js - Directive system → Reactivity engine: binds effects
packages/alpinejs/src/directives.js - Directive system → DOM mutation observer: tracks removal
packages/alpinejs/src/directives.js - Expression evaluator → Data scopes: reads scopes
packages/alpinejs/src/evaluator.js - Expression evaluator → Magic properties: injects
packages/alpinejs/src/evaluator.js - Magic properties → Directive system: gets utilities
packages/alpinejs/src/magics.js - Magic properties → DOM mutation observer: cleans up on removal
packages/alpinejs/src/magics.js - DOM mutation observer → Job scheduler: queues jobs
packages/alpinejs/src/mutation.js - Transitions → DOM mutation observer: mutates DOM through
packages/alpinejs/src/directives/x-transition.js - DOM cloning → Tree lifecycle: uses lifecycle
packages/alpinejs/src/clone.js - Browser behavior plugins → HTML markup: adds directives
- CSP evaluator → CSP expression parser: parses expressions with
packages/csp/src/evaluator.js - Accessible controls → List context: uses list state
packages/ui/src/combobox.js - Accessible controls → List context: uses list state
packages/ui/src/listbox.js