lg-p5
Create p5.js instance as a Vue component.
Quick start
Script
<script src="https://unpkg.com/vue@2"></script>
<script src="https://unpkg.com/lg-p5"></script>
<div id="app">
<lg-p5 v-on="this"></lg-p5>
</div>
<script>
new Vue({
el: '#app',
methods: {
setup(sketch) {
sketch.background('green');
sketch.text('Hello p5!', 20, 20);
}
}
});
</script>NPM
npm install --save vue@2 lg-p5import Vue from 'vue';
import LgP5 from 'lg-p5';
export default {
methods: {
setup(sketch) {
sketch.background('green');
sketch.text('Hello p5!', 20, 20);
}
},
render(h) {
return h(LgP5, {on: this});
}
};Usage
v-on object syntax
In the examples above v-on="this" and {on: this} are a short (and hacky) way to avoid handling every p5 event explicitly. You might want to use one of the other options:
<lg-p5 v-on="{setup, draw, keypressed}"></lg-p5>
<!-- which is equivalent to: -->
<lg-p5
@setup="setup"
@draw="draw"
@keypressed="keypressed">
</lg-p5>on: {
setup: this.setup,
draw: this.draw,
keypressed: this.keypressed
}See also v-on object syntax.
Events - p5 and Vue
Every p5 event is exposed as a Vue event. The first argument is the sketch object used for drawing and everything else:
methods: {
draw(sk) {
// draw a line between the previous
// and the current mouse position
sk.line(sk.pmouseX, sk.pmouseY, sk.mouseX, sk.mouseY);
},
keypressed(sk) {
// convert the key code to it's string
// representation and print it
const key = String.fromCharCode(sk.keyCode);
sk.print(key);
}
}Using methods makes it possible to access the current component:
// green background
data: {
color: [0, 255, 0]
},
methods: {
draw(sketch) {
sketch.background(...this.color);
}
}Event names
Each event emitted by lg-p5 has the same name as the corresponding p5 event, but lowercase.
mouseclicked, not mouseClicked
Missing events
Currently all p5 events [are supported], but there is an escape hatch. For example, if windowResized was missing, it's (lowercase) name could be passed to additional-events prop to make lg-p5 aware of it:
<lg-p5
:additional-events="['windowresized']"
@windowresized="windowresized"
></lg-p5>Importing existing sketches
In addition to p5 events, there's a @sketch event for importing an existing p5 sketch written in instance mode.
<lg-p5 @sketch="sketch"></lg-p5>
<script>
new Vue({
methods: {
sketch(sk) {
const clicks = [];
sk.mouseClicked = () => {
// save clicks to array
clicks.push({ x: sk.mouseX, y: sk.mouseY });
}
sk.draw = () => {
// draw a circle around each clicked position
clicks.forEach(({ x, y }) => {
sk.ellipse(x, y, 10, 10);
});
}
}
}
});
</script>Remember to use arrow functions if you need this.
@sketch can be used in parallel with other events. Functions defined in the @sketch handler will always be called first.