Vue 3 composition API in a nutshell
Vue 3 composition API in a nutshell
By Lars Janssen
3 min read
Vue 3 has been launched with the composition API. In this article we dive deeper into this subject and compare it with the options API (old way).
- Authors
- Name
- Lars Janssen
- linkedinLars Janssen
- Github
- githublarsjanssen6
Vue 3 has been released on Monday, February 7, 2022. Since the release of Vue 3 the ecosystem got a boost (for example with Vite) and the composition API has been introduced. In this article I will explain some core concepts of the composition API.
What is the composition API?
With the arrival of Vue 3 we can declare components with the options API (old way) or the composition API (new way). The composition API is a set of APIs that allows us to author Vue components using imported functions instead of declaring options.
With the composition API the Vue components are more structured and readable, this can be very helpful especially when components grow. The following image displays more structured components.
According to the official Vue documentation, the most important benefits are:
- Better reusability of logic;
- More flexible code organization;
- Better type inference;
- Smaller production bundle and less overhead.
Setup
With the composition API we can declare our Vue template in 2 different ways:
Method 1:
<script setup>const aProperty: string = 'Test';</script>
Method 2:
<script>
export default {
setup() {
const state = reactive({ aProperty: 'Test' });
return {
state
}
}
}
</script>
Both methods are working in practice most developer use method 1, it's more readable and less code is needed.
Hooks
The composition API is using hooks instead of integrated functions. With the options API we had to define integrated functions like this:
export default {
mounted() {
//Logic
},
data() {
//Data
},
watch: {
//Watch data
},
}
With the composition API we can use hooks for this:
onMounted(() => {
//Logic
})
const dataProperty: string = ref('')
watch(() => {
//Watch data
})
Props
Vue 3 has been rewritten in Typescript. The integration of Vue in our TypeScript application is now more smooth since Vue 3 is rewritten in TypeScript. Props are a good example of this. With the options API:
props: {
dogNames: {
type: Array,
default: []
}
}
In Vue 2 you could already define a type, but this was still quite limited. You now have the option to use interfaces. With the composition API:
interface Props {
dogNames: Array<String>
}
let props = withDefaults(defineProps<Props>(), {
dogNames: [],
})
Events
When dispatching events to our parent components we notice the better Typescript support as well. Types can be declared so the developer knows if an incorrect value is being passed. Composition API:
const emit = defineEmits<{
(event: 'dogNames', value: Array<string>): void
}>()
emit('dogNames', ['Snuffel'])
With the options API:
$emit('dogNames', ['Snuffel'])
Code reusage with hooks
With the options API duplicate code is prevented with mixins. When using multiple mixins you quickly lose the overview and are often wondering where data or logic comes from. With the composition API we can use our own hooks for this.
const useGetPreferences = () => {
return useQuery(['Preference'], async () =>
PreferencesService.getPreferences().then(({ data }) => data)
)
}
export { useGetPreferences }
It's used like this:
const { data: preferences } = useGetPreferences()
With the options API:
var mixin = {
methods: {
useGetPreferences() {
return useQuery(['Preference'], async () =>
PreferencesService.getPreferences().then(({ data }) => data)
)
},
},
}
It's used like this:
new Vue({
mixins: [mixin],
})
Composition API and options API together
Maybe you are wondering if it is possible to use these API's together? Yes, that's possible! If you want to migrate a project to the composition api, this is very useful. However, for the future, the composition API will become the standard.
Final thoughts
Vue 3 has been a huge update compared to Vue 2. You could almost see it as a new framework rather than an update. Within iO, a number of projects are now done in Vue 3, in which I participate. In the beginning I had to get used to the new structure of Vue and the composition API. Now I see the benefits more and more, and understand why this update was necessary. Especially the Typescript integration is very good, and with hooks we reuse our code more easily and is it more readable.
Upcoming events
The Test Automation Meetup
PLEASE RSVP SO THAT WE KNOW HOW MUCH FOOD WE WILL NEED Test automation is a cornerstone of effective software development. It's about creating robust, predictable test suites that enhance quality and reliability. By diving into automation, you're architecting systems that ensure consistency and catch issues early. This expertise not only improves the development process but also broadens your skillset, making you a more versatile team member. Whether you're a developer looking to enhance your testing skills or a QA professional aiming to dive deeper into automation, RSVP for an evening of learning, delicious food, and the fusion of coding and quality assurance! 🚀🚀 18:00 – 🚪 Doors open to the public 18:15 – 🍕 Let’s eat 19:00 – 📢 First round of Talks 19:45 – 🍹 Small break 20:00 – 📢 Second round of Talks 20:45 – 🍻 Drinks 21:00 – 🙋♀️ See you next time? First Round of Talks: The Power of Cross-browser Component Testing - Clarke Verdel, SR. Front-end Developer at iO How can you use Component Testing to ensure consistency cross-browser? Second Round of Talks: Omg who wrote this **** code!? - Erwin Heitzman, SR. Test Automation Engineer at Rabobank How can tests help you and your team? Beyond the Unit Test - Christian Würthner, SR. Android Developer at iO How can you do advanced automated testing for, for instance, biometrics? RSVP now to secure your spot, and let's explore the fascinating world of test automation together!
| Coven of Wisdom - Amsterdam
Go to page for The Test Automation MeetupCoven of Wisdom - Herentals - Winter `24 edition
Worstelen jij en je team met automated testing en performance? Kom naar onze meetup waar ervaren sprekers hun inzichten en ervaringen delen over het bouwen van robuuste en efficiënte applicaties. Schrijf je in voor een avond vol kennis, heerlijk eten en een mix van creativiteit en technologie! 🚀 18:00 – 🚪 Deuren open 18:15 – 🍕 Food & drinks 19:00 – 📢 Talk 1 20:00 – 🍹 Kleine pauze 20:15 – 📢 Talk 2 21:00 – 🙋♀️ Drinks 22:00 – 🍻 Tot de volgende keer? Tijdens deze meetup gaan we dieper in op automated testing en performance. Onze sprekers delen heel wat praktische inzichten en ervaringen. Ze vertellen je hoe je effectieve geautomatiseerde tests kunt schrijven en onderhouden, en hoe je de prestaties van je applicatie kunt optimaliseren. Houd onze updates in de gaten voor meer informatie over de sprekers en hun specifieke onderwerpen. Over iO Wij zijn iO: een groeiend team van experts die end-to-end-diensten aanbieden voor communicatie en digitale transformatie. We denken groot en werken lokaal. Aan strategie, creatie, content, marketing en technologie. In nauwe samenwerking met onze klanten om hun merken te versterken, hun digitale systemen te verbeteren en hun toekomstbestendige groei veilig te stellen. We helpen klanten niet alleen hun zakelijke doelen te bereiken. Samen verkennen en benutten we de eindeloze mogelijkheden die markten in constante verandering bieden. De springplank voor die visie is talent. Onze campus is onze broedplaats voor innovatie, die een omgeving creëert die talent de ruimte en stimulans geeft die het nodig heeft om te ontkiemen, te ontwikkelen en te floreren. Want werken aan de infinite opportunities van morgen, dat doen we vandaag.
| Coven of Wisdom Herentals
Go to page for Coven of Wisdom - Herentals - Winter `24 editionMastering Event-Driven Design
PLEASE RSVP SO THAT WE KNOW HOW MUCH FOOD WE WILL NEED Are you and your team struggling with event-driven microservices? Join us for a meetup with Mehmet Akif Tütüncü, a senior software engineer, who has given multiple great talks so far and Allard Buijze founder of CTO and founder of AxonIQ, who built the fundaments of the Axon Framework. RSVP for an evening of learning, delicious food, and the fusion of creativity and tech! 🚀 18:00 – 🚪 Doors open to the public 18:15 – 🍕 Let’s eat 19:00 – 📢 Getting Your Axe On Event Sourcing with Axon Framework 20:00 – 🍹 Small break 20:15 – 📢 Event-Driven Microservices - Beyond the Fairy Tale 21:00 – 🙋♀️ drinks 22:00 – 🍻 See you next time? Details: Getting Your Axe On - Event Sourcing with Axon Framework In this presentation, we will explore the basics of event-driven architecture using Axon Framework. We'll start by explaining key concepts such as Event Sourcing and Command Query Responsibility Segregation (CQRS), and how they can improve the scalability and maintainability of modern applications. You will learn what Axon Framework is, how it simplifies implementing these patterns, and see hands-on examples of setting up a project with Axon Framework and Spring Boot. Whether you are new to these concepts or looking to understand them more, this session will provide practical insights and tools to help you build resilient and efficient applications. Event-Driven Microservices - Beyond the Fairy Tale Our applications need to be faster, better, bigger, smarter, and more enjoyable to meet our demanding end-users needs. In recent years, the way we build, run, and operate our software has changed significantly. We use scalable platforms to deploy and manage our applications. Instead of big monolithic deployment applications, we now deploy small, functionally consistent components as microservices. Problem. Solved. Right? Unfortunately, for most of us, microservices, and especially their event-driven variants, do not deliver on the beautiful, fairy-tale-like promises that surround them.In this session, Allard will share a different take on microservices. We will see that not much has changed in how we build software, which is why so many “microservices projects” fail nowadays. What lessons can we learn from concepts like DDD, CQRS, and Event Sourcing to help manage the complexity of our systems? He will also show how message-driven communication allows us to focus on finding the boundaries of functionally cohesive components, which we can evolve into microservices should the need arise.
| Coven of Wisdom - Utrecht
Go to page for Mastering Event-Driven Design