Không có mô tả

Hugo e5c20e24fe Use npm CDN link		4 năm trước cách đây
.github	5ed0ac1003 chore(workflow0	5 năm trước cách đây
dist	6175856e9f wip	4 năm trước cách đây
examples	319c73a5e3 wip	4 năm trước cách đây
src	6175856e9f wip	4 năm trước cách đây
tests	1884451eac tests(cover array methods)	4 năm trước cách đây
.gitignore	0681917e03 wip	4 năm trước cách đây
LICENSE.md	9436518c08 Create License file	5 năm trước cách đây
README.md	e5c20e24fe Use npm CDN link	4 năm trước cách đây
babel.config.js	cb5e7ccd65 chore(tests)	5 năm trước cách đây
jest.config.js	326c804bf2 tests()	5 năm trước cách đây
package.json	e439fad3d0 1.1.0	4 năm trước cách đây
yarn.lock	6de4b2c874 feature(migrate to magic property)	4 năm trước cách đây

✨ Help to support the maintenance of this package by sponsoring me.

🌲 Spruce

A lightweight state management layer for Alpine.js

About

Many large frameworks have their own state management solutions. One thing these libraries have in common is a higher level of complexity and a wide range of API interactions. Since Alpine.js is designed to be a simpler and lighter alternative to larger frameworks such as Vue and React, shouldn't the state management solution be as simple, if not simpler, too?

Installation

CDN

Include the following <script> tag in the <head> of your document:

<script src="https://cdn.jsdelivr.net/npm/@ryangjchandler/spruce@1.x.x/dist/spruce.umd.js"></script>

Important: This must be added before loading Alpine.js when using CDN links.

Manual

If you wish to include Spruce with your own bundle:

yarn add @ryangjchandler/spruce

or:

npm install @ryangjchandler/spruce --save

Then add the following to your script:

import Spruce from '@ryangjchandler/spruce'

Quick start

To verify you have correctly installed Spruce, copy & paste the following code snippet into your project.

<div x-data>
    <div x-show="$store.modal.open === 'login'">
        <p>
            This "login" modal isn't built with a11y in mind, don't actually use it
        </p>
    </div>
</div>

<div x-data>
    <div x-show="$store.modal.open === 'register'">
        <p>
            This "register" modal isn't built with a11y in mind, don't actually use it
        </p>
    </div>
</div>

<div x-data>
    <select x-model="$store.modal.open">
        <option value="login" selected>login</option>
        <option value="register">register</option>
    </select>
</div>

<script>
    Spruce.store('modal', {
        open: 'login',
    });
</script>

To see what the code should do, use this CodePen. Thanks @HugoDF!

Usage

Spruce exposes less than a handful of possible interaction points. There is an extremely simple "subscriptions" interaction which connects the roots from your Alpine component to the global store, then there is the "stores" interaction which allows you to define scopes of global state for use throughout your components.

Entry point

If you are using the CDN build, you can interact with Spruce using the window.Spruce variable:

<script>
    Spruce.store('modals', {
        open: 'login',
    })
</script>

If you are importing Spruce into your own bundle, you can interact with it like any other variable:

store.js

import Spruce from '@ryangjchandler/spruce'

Spruce.store('modals', {
    open: 'login'
})

export default Spruce

app.js

import './store'
import 'alpinejs'

Note: You must import your store before Alpine.

Subscribing your components

Spruce hooks into Alpine using the "magic properties" API, meaning there are no extra steps needed. Start using the $store variable in your components right away.

<div x-data="{}">
    <span x-text="$store.application.name"></span>
</div>

Defining global state

To define a piece of global state, you can use the Spruce.store() method:

Spruce.store('application', {
    name: 'Amazing Alpine Application'
})

The first argument defines the top level property of the scope. The second argument defines the state for the scope, it could be a string, integer or object with nested properties.

To access the name property, you can do the following inside of your component:

<div x-data="{}">
    <span x-text="$store.application.name"></span>
</div>

The <span> will now have "Amazing Alpine Application" set as its innerText .

Modifying state from outside of Alpine

You can modify your global state from external scripts using the Spruce.store() method too:

Spruce.store('application', {
    name: 'Amazing Alpine Application'
})

Spruce.store('application').name = 'Amazing Spruce Integration'

This will trigger Alpine to re-evaluate your subscribed components and re-render.

Resetting global state

A Spruce.reset() method is provided so that you can completely overwrite a global store:

Spruce.store('application', {
    name: 'Amazing Alpine Application'
})

Spruce.reset('application', {
    name: 'Reset Application'
})

Calling the reset method will make the new state reactive and cause subscribed components to re-render.

Externally watching for changes

You can register watchers in a similar fashion to Alpine. All you need is the full dot-notation representation of your piece of state and a callback.

Spruce.store('form', {
    name: 'Ryan',
    email: 'support@ryangjchandler.co.uk'
})

Spruce.watch('form.email', (old, next) => {
    // do something with the values here
})

In the above snippet, when we change the value of form.email either from a component or externally in a separate JavaScript file, our callback will be invoked and will receive the old value, as well as the new value. This can be useful for running automatic inline validation when a property changes, or triggering an action elsewhere in another component without the need for dispatching events.

Note: you can get stuck in an watch loop if you're updating other store properties that also have watchers defined.

Event bus

Spruce ships with a basic event bus. It exposes two methods:

Spruce.on(eventName, callback) - this can be used to register an event listener. This will react to any internal events, such as init . Your callback will receive a single detail property which contains any data sent from the event, as well as the global store.
```
Spruce.on('init', ({ store }) => {
// do something with the store here...
})
```
Spruce.once(eventName, callback) - this can be used to register an event listener that is only run a single time. This is useful for one time events, such as fetching HTML from the server when hovering over a button or similar.
```
Spruce.once('event', () => {
// do something once...
})
```
Spruce.off(eventName, callback) - this can be used to unhook or de-register an event listener.
```
var callback = () => {}

Spruce.off('init', callback)
```

You can also unhook a listener using the function returned by Spruce.on() . This is especially useful for anonymous function callbacks.

var off = Spruce.on('event', () => {})

off()

Spruce.emit(eventName, data = {}) - this can be used to emit an event. The first argument should be the name of the event, the second should be an object containing data. This will be merged in with the core data, which consists of a store property. When emitting an event, a browser event will also be dispatched with a spruce: prefix.
```
Spruce.emit('event-name', {
foo: 'bar'
})
```

In the example above, a spruce:event-name event will be fired on the window level, so you could register an event listener inside of your Alpine component:

<div x-data @spruce:event-name.window="foo = $event.detail.store.foo">
</div>

Versioning

This projects follow the Semantic Versioning guidelines. This means that there could be breaking changes on minor version changes, up until v1.x is reached.

For example, 0.1 -> 0.2 might introduce a breaking change.

License

Licensed under the MIT license, see LICENSE.md for details.

README.md