Composable naming conventions (use prefix) in Vue

Introduction

Using prefixes in composable names helps keep your code clear and organized. It shows what the composable does and avoids name clashes.

When creating reusable logic pieces in Vue 3 using the Composition API.

When you want to clearly identify composables related to a specific feature or domain.

When working in a team to make composable purposes obvious at a glance.

When you want to avoid naming conflicts with other composables or variables.

When you want to improve code readability and maintainability.

Syntax

Vue

function usePrefixFeatureName() {
  // composable logic here
  return { /* reactive data or methods */ };
}

Start composable names with use to follow Vue community conventions.

Add a clear prefix that groups related composables, like useAuth or useCart.

Examples

This composable handles login logic and is clearly part of the auth group.

Vue

function useAuthLogin() {
  // logic for login
  return { loginUser };
}

This composable manages shopping cart items, grouped under 'cart'.

Vue

function useCartItems() {
  // logic for cart items
  return { items };
}

This composable deals with user profile data, grouped under 'user'.

Vue

function useUserProfile() {
  // logic for user profile
  return { profile };
}

Sample Program

This example shows a composable named useCounter that manages a count state. The prefix use indicates it is a composable. The component uses this composable to display and increment the count.

Vue

import { ref } from 'vue';

// Composable with prefix 'useCounter'
export function useCounter() {
  const count = ref(0);
  function increment() {
    count.value++;
  }
  return { count, increment };
}

// Vue component using the composable
import { defineComponent } from 'vue';
import { useCounter } from './useCounter';

export default defineComponent({
  setup() {
    const { count, increment } = useCounter();
    return { count, increment };
  },
  template: `<button @click="increment">Count: {{ count }}</button>`
});

Important Notes

Always use the use prefix for composables to follow Vue style.

Choose prefixes that describe the feature or domain clearly.

Keep composable names short but descriptive to improve readability.

Summary

Composable names should start with use to show they are composables.

Use prefixes to group related composables and avoid confusion.

Clear naming helps you and others understand your code faster.

Practice

1. Why should composable functions in Vue start with the prefix use?

easy

A. To make them private and inaccessible outside the file

B. To make them run faster in the browser

C. To clearly indicate they are composables and follow Vue conventions

D. To prevent them from being imported accidentally

Solution

1. Step 1: Understand Vue composable naming conventions

   Vue recommends starting composable function names with use to clearly identify them as composables.

2. Step 2: Recognize the purpose of the prefix

   The prefix helps developers quickly know the function is a composable and follows community standards.

3. Final Answer:

   To clearly indicate they are composables and follow Vue conventions -> Option C

4. Quick Check:

   Composable prefix = use [OK]

Hint: Composable names start with 'use' to show their purpose [OK]

Common Mistakes:

• Thinking prefix affects performance
• Believing prefix hides the function
• Ignoring naming conventions

2. Which of the following is the correct syntax for naming a composable that fetches user data?

easy

A. useFetchUserData()

B. fetchUserData()

C. getUserData()

D. userDataFetch()

Solution

1. Step 1: Identify the composable prefix

   The composable should start with use to follow Vue naming conventions.

2. Step 2: Check the full function name

   useFetchUserData clearly shows it is a composable fetching user data.

3. Final Answer:

   useFetchUserData() -> Option A

4. Quick Check:

   Composable name starts with 'use' [OK]

Hint: Composable names always start with 'use' [OK]

Common Mistakes:

• Omitting the 'use' prefix
• Using verbs without 'use'
• Confusing composable with normal functions

3. Given this composable code:

export function useCounter() {
  const count = ref(0);
  function increment() { count.value++ }
  return { count, increment };
}

What will be the output of console.log(counter.count.value) after calling counter.increment() twice?

medium

A. 1

B. 2

C. 0

D. undefined

Solution

1. Step 1: Understand the initial state

   The count ref starts at 0.

2. Step 2: Apply the increment function twice

   Each call to increment() increases count.value by 1, so after two calls, count.value is 2.

3. Final Answer:

   2 -> Option B

4. Quick Check:

   Increment twice = count 2 [OK]

Hint: Increment twice means count.value becomes 2 [OK]

Common Mistakes:

• Forgetting to access .value of ref
• Assuming count resets
• Confusing function call effects

4. Identify the error in this composable naming:

export function fetchData() {
  // composable logic
}

medium

A. Composable functions cannot be exported

B. Function should be a class, not a function

C. Function name is too long

D. Missing 'use' prefix in function name

Solution

1. Step 1: Check naming conventions for composables

   Composable functions must start with use to be recognized as such.

2. Step 2: Identify the missing prefix

   The function fetchData lacks the use prefix, so it breaks the convention.

3. Final Answer:

   Missing 'use' prefix in function name -> Option D

4. Quick Check:

   Composable names need 'use' prefix [OK]

Hint: Composable names must start with 'use' prefix [OK]

Common Mistakes:

• Ignoring naming conventions
• Thinking export is disallowed
• Confusing function types

5. You have multiple composables related to authentication: useAuthLogin, useAuthLogout, and useAuthStatus. Why is using the useAuth prefix a good practice?

hard

A. It groups related composables, making code easier to understand and maintain

B. It makes the composables run faster by grouping them

C. It hides the composables from other parts of the app

D. It automatically imports all composables with the prefix

Solution

1. Step 1: Understand prefix grouping purpose

   Using a common prefix groups related composables logically.

2. Step 2: Recognize benefits of grouping

   This grouping helps developers quickly find and understand related functions, improving maintainability.

3. Final Answer:

   It groups related composables, making code easier to understand and maintain -> Option A

4. Quick Check:

   Prefix groups related composables [OK]

Hint: Use prefixes to group related composables clearly [OK]

Common Mistakes:

• Assuming prefix affects performance
• Thinking prefix hides composables
• Believing prefix auto-imports functions