petite-vue
is an alternative distribution of Vue optimized for progressive enhancement. It provides the same template syntax and reactivity mental model with standard Vue. However, it is specifically optimized for "sprinkling" small amount of interactions on an existing HTML page rendered by a server framework.
- Only 5.5kb
- DOM-based, mutates in place
- Driven by
@vue/reactivity
-
This is pretty new. There are probably bugs and there might still be API changes, so use at your own risk.
-
The issue list is intentionally disabled because I have higher priority things to focus on for now and don't want to be distracted. If you found a bug, you'll have to either workaround it or submit a PR to fix it yourself. That said, feel free to use the discussions tab to help each other out.
-
Feature requests are unlikely to be accepted at this time - the scope of this project is intentionally kept to a bare minimum.
<script src="https://unpkg.com/petite-vue" defer init></script>
<!-- anywhere on the page -->
<div v-scope="{ count: 0 }">
{{ count }}
<button @click="count++">inc</button>
</div>
- Use
v-scope
to mark regions on the page that should be controlled bypetite-vue
. - The
defer
attribute makes the script execute after HTML content is parsed. - The
init
attribute tellspetite-vue
to automatically query and initialize all elements that havev-scope
on the page.
If you don't want the auto init, remove the init
attribute and move the scripts to end of <body>
:
<script src="https://unpkg.com/petite-vue"></script>
<script>
PetiteVue.createApp().mount()
</script>
Or, use the ES modules build:
<script type="module">
import { createApp } from 'https://unpkg.com/petite-vue?module'
createApp().mount()
<script>
The createApp
function accepts a data object that serves as the root scope for all expressions. This can be used for simple global state management:
<script type="module">
import { createApp } from 'https://unpkg.com/petite-vue?module'
createApp({
// exposed to all expressions
count: 0,
// getters
get plusOne() {
return this.count + 1
},
// methods
increment() {
this.count++
}
}).mount()
</script>
<!-- v-scope value can be omitted -->
<div v-scope>
<p>{{ count }}</p>
<p>{{ plusOne }}</p>
<button @click="increment">increment</button>
</div>
Note v-scope
doesn't need to have a value here and simply serves as a hint for petite-vue
to process the element.
You can specify a mount target (selector or element) to limit petite-vue
to only that region of the page:
createApp().mount('#only-this-div')
This also means you can have multiple petite-vue
apps to control different regions on the same page:
createApp({
// root scope for app one
}).mount('#app1')
createApp({
// root scope for app two
}).mount('#app2')
You can listen to the mounted
and unmounted
lifecycle events for each element:
<div
v-if="show"
@mounted="console.log('mounted!')"
@unmounted="console.log('unmounted!')"
></div>
Use v-effect
to execute reactive inline statements:
<div v-scope="{ count: 0 }">
<div v-effect="$el.textContent = count"></div>
<button @click="count++">++</button>
</div>
The effect uses count
which is a reactive data source, so it will re-run whenever count
changes.
There are no components, but logic can be shared across the app or encapsulated in setup-like functions:
<script type="module">
import { createApp } from 'https://unpkg.com/petite-vue?module'
function ComponentLike(props) {
return {
count: props.initialCount,
inc() {
this.count++
}
}
}
createApp({
ComponentLike
}).mount()
</script>
<div v-scope="ComponentLike({ initialCount: 10 })">
<p>{{ count }}</p>
<button @click="inc">increment</button>
</div>
You can use the reactive
method (re-exported from @vue/reactivity
) to create global state singletons:
<script type="module">
import { createApp, reactive } from 'https://unpkg.com/petite-vue?module'
const store = reactive({
count: 0,
inc() {
this.count++
}
})
// manipulate it here
store.inc()
createApp({
// share it with app scopes
store
}).mount()
</script>
<div v-scope="{ localCount: 0 }">
<p>Global {{ store.count }}</p>
<button @click="store.inc">increment</button>
<p>Local {{ localCount }}</p>
<button @click="localCount++">increment</button>
</div>
Custom directives are also supported but with a different interface:
const myDirective = (ctx) => {
// the element the directive is on
ctx.el
// the raw value expression
// e.g. v-my-dir="x" then this would be "x"
ctx.exp
// v-my-dir:foo -> "foo"
ctx.arg
// v-my-dir.mod -> { mod: true }
ctx.modifiers
// evaluate the expression and get its value
ctx.get()
// evaluate arbitrary expression in current scope
ctx.get(`${ctx.exp} + 10`)
// run reactive effect
ctx.effect(() => {
// this will re-run every time the get() value changes
console.log(ctx.get())
})
return () => {
// cleanup if the element is unmounted
}
}
// register the directive
createApp().directive('my-dir', myDirective).mount()
This is how v-html
is implemented:
const html = ({ el, get, effect }) => {
effect(() => {
el.innerHTML = get()
})
}
Check out the examples directory.
v-scope
v-effect
@mounted
&@unmounted
events
createApp()
(accepts global state instead of root component)- Custom directives
{{ }}
text bindingsv-bind
(including:
shorthand and class/style special handling)v-on
(including@
shorthand and all modifiers)v-model
(all input types + non-string:value
bindings)v-if
/v-else
/v-else-if
v-for
v-show
v-html
v-text
v-pre
v-cloak
reactive()
nextTick()
Some features are dropped because they have a relatively low utility/size ratio in the context of progressive enhancement. If you need these features, you should probably just use standard Vue.
ref()
,computed()
etc.- Components (see "Reuse Logic" section above)
- Template refs (just use selectors)
- Render functions (
petite-vue
has no virtual DOM) - Reactivity for Collection Types (Map, Set, etc., removed for smaller size)
- Transition, KeepAlive, Teleport, KeepAlive
v-for
deep destructurev-on="object"
v-once
v-is
&<component :is="xxx">
v-bind:style
auto-prefixing
- This is indeed addressing a similar scope to Alpine, but aims to be even more minimal.
petite-vue
is less than half the size of Alpine.petite-vue
has no transition system (maybe this can be an opt-in plugin).
- Alpine is developing its own ecosystem and likely will diverge more from Vue in the future.
petite-vue
aligns with standard Vue behavior whenever possible, so it's less friction moving to standard Vue if needed. It's intended to cover the progressive enhancement use case where standard Vue is less optimized for nowadays.