paint-brush
Setting Default Inject/Provide Values in Vueby@smpnjn
1,310 reads
1,310 reads

Setting Default Inject/Provide Values in Vue

by Johnny SimpsonAugust 1st, 2022
Read on Terminal Reader
Read this story w/o Javascript
tldt arrow

Too Long; Didn't Read

Vue uses provide and inject as a method to send data down multiple levels without having to use **properties** - but did you know you can set default values for any injected data, should it not be injected in the first place? Let's look at how it works. By default, `inject` expects a default value to be set for a `provide` key - and if it's not, it'll throw a runtime error. As such, it's beneficial to set a default. value so that a runtime. error does not fire.
featured image - Setting Default Inject/Provide Values in Vue
Johnny Simpson HackerNoon profile picture


Vue uses provide and inject as a method to send data down multiple levels without having to use properties - but did you know you can set default values for any injected data, should it not be injected in the first place? Let's look at how it works.

Setting default values with provide and inject in Vue

If you're not sure how provide and inject work, you can read about it here. By default, inject expects a default value to be set for a provide key - and if it's not, it'll throw a runtime error. As such, it's beneficial to set a default value so that a runtime error does not fire.

So let's look at an example. Say you provide some data in your parent like this:


<script setup>
    import { provide, ref } from 'vue'
    const message = ref('message');
    provide('myKey', message);
</script>


If you then inject it somewhere, you can use the second argument to set the default value. For example:


<script setup>
    import { inject } from 'vue'
    const message = inject('myKey', 'the default value')
</script>


In this example, if myKey cannot be found, the default value will be set to the default value instead. You can achieve the same thing with the Options API like so:


export default {
    inject: {
        message: {
            myKey: 'the default value'
        }
    }
}


Setting default values for injectors in Vue is best practice, and helps prevent unexpected runtime errors.



Also published here.