vuejs / vuejs/docs

Styleguide recommends to use kebab-case for custom events, but Vue emits camelCase `update:modelValue` under the hood

Open
#1,250 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

Hello!
I have met two statements in the docs and I can't understand them.

  1. Styleguide, where we see the recommendation to use kebab-case for emited events: https://v3.vuejs.org/guide/component-custom-events.html#event-names
  2. Migration strategy, where we see that Vue emits update:modelValue by default which is in camelCase. Can you please tell, why did you decide to use camelCase in the v-model strategy and at the same time recommend using kebab-case? https://v3.vuejs.org/guide/migration/v-model.html#migration-strategy

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the Styleguide event-names section with the Migration strategy v-model section linked in the issue. Check whether their guidance about kebab-case and update:modelValue is intentionally different, then clarify the documentation so the relationship and naming rationale are explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.