stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/createInjectionState.md

category

category
State

createInjectionState

Create global state that can be injected into components.

Usage

// useCounterStore.ts
import { createInjectionState } from '@vueuse/core';
import { computed, shallowRef } from 'vue';

const [useProvideCounterStore, useCounterStore] = createInjectionState((initialValue: number) => {
  // state
  const count = shallowRef(initialValue);

  // getters
  const double = computed(() => count.value * 2);

  // actions
  function increment() {
    count.value++;
  }

  return { count, double, increment };
});

export { useProvideCounterStore };

// If you want to hide `useCounterStore` and wrap it in default value logic or throw error logic, please don't export `useCounterStore`
export { useCounterStore };

export function useCounterStoreWithDefaultValue() {
  return (
    useCounterStore() ?? {
      count: shallowRef(0),
      double: shallowRef(0),
      increment: () => {},
    }
  );
}

export function useCounterStoreOrThrow() {
  const counterStore = useCounterStore();
  if (counterStore == null)
    throw new Error('Please call `useProvideCounterStore` on the appropriate parent component');
  return counterStore;
}

<!-- RootComponent.vue -->
<script setup lang="ts">
// @filename: useCounterStore.ts
// @include: useCounterStore
// ---cut---
import { useProvideCounterStore } from './useCounterStore';

useProvideCounterStore(0);
</script>

<template>
  <div>
    <slot />
  </div>
</template>

<!-- CountComponent.vue -->
<script setup lang="ts">
// @filename: useCounterStore.ts
// @include: useCounterStore
// ---cut---
import { useCounterStore } from './useCounterStore';

// use non-null assertion operator to ignore the case that store is not provided.
const { count, double } = useCounterStore()!;
// if you want to allow component to working without providing store, you can use follow code instead:
// const { count, double } = useCounterStore() ?? { count: shallowRef(0), double: shallowRef(0) }
// also, you can use another hook to provide default value
// const { count, double } = useCounterStoreWithDefaultValue()
// or throw error
// const { count, double } = useCounterStoreOrThrow()
</script>

<template>
  <ul>
    <li>count: {{ count }}</li>
    <li>double: {{ double }}</li>
  </ul>
</template>

<!-- ButtonComponent.vue -->
<script setup lang="ts">
// @filename: useCounterStore.ts
// @include: useCounterStore
// ---cut---
import { useCounterStore } from './useCounterStore';

// use non-null assertion operator to ignore the case that store is not provided.
const { increment } = useCounterStore()!;
</script>

<template>
  <button @click="increment">+</button>
</template>

Provide a custom InjectionKey

// useCounterStore.ts
import { createInjectionState } from '@vueuse/core';
import { computed, shallowRef } from 'vue';

// custom injectionKey
const CounterStoreKey = 'counter-store';

const [useProvideCounterStore, useCounterStore] = createInjectionState(
  (initialValue: number) => {
    // state
    const count = shallowRef(initialValue);

    // getters
    const double = computed(() => count.value * 2);

    // actions
    function increment() {
      count.value++;
    }

    return { count, double, increment };
  },
  { injectionKey: CounterStoreKey },
);

Provide a custom default value

// useCounterStore.ts
import { createInjectionState } from '@vueuse/core';
import { computed, shallowRef } from 'vue';

const [useProvideCounterStore, useCounterStore] = createInjectionState(
  (initialValue: number) => {
    // state
    const count = shallowRef(initialValue);

    // getters
    const double = computed(() => count.value * 2);

    // actions
    function increment() {
      count.value++;
    }

    return { count, double, increment };
  },
  { defaultValue: 0 },
);

Type Declarations

export type CreateInjectionStateReturn<Arguments extends Array<any>, Return> = Readonly<
  [
    /**
     * Call this function in a provider component to create and provide the state.
     *
     * @param args Arguments passed to the composable
     * @returns The state returned by the composable
     */
    useProvidingState: (...args: Arguments) => Return,
    /**
     * Call this function in a consumer component to inject the state.
     *
     * @returns The injected state, or `undefined` if not provided and no default value was set.
     */
    useInjectedState: () => Return | undefined,
  ]
>;
export interface CreateInjectionStateOptions<Return> {
  /**
   * Custom injectionKey for InjectionState
   */
  injectionKey?: string | InjectionKey<Return>;
  /**
   * Default value for the InjectionState
   */
  defaultValue?: Return;
}
/**
 * Create global state that can be injected into components.
 *
 * @see https://vueuse.org/createInjectionState
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function createInjectionState<Arguments extends Array<any>, Return>(
  composable: (...args: Arguments) => Return,
  options?: CreateInjectionStateOptions<Return>,
): CreateInjectionStateReturn<Arguments, Return>;