reactjs / reactjs/react.dev

Hooks docs: Props usage isn't obvious

Aberta
#1,775 1 comentário 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
JavaScript
Estrelas
11.8k
Forks
7.9k
Merge médio
1d 11h
PRs com merge (30d)
11

Descrição

Seen this a few times as a bit of a common theme in Reactiflux's #need-help channel. New Hooks users (with only minimal prior React experience) are hitting the Hooks docs, and having some success using basic hooks (e.g., useState), but are missing how "hook components" consume props.

I think there's a bit of an issue of "hook components" not necessarily being recognized as "function components", or users not being familiar with function components to start with.

Looking at the first two pages of hooks docs, we get to the fourth example component before any props are used. I'm (unfortunately) guessing that users aren't reading solidly to that point to see the example.

Proposed solution

Could the intro page's example include using props? Or perhaps a second intro page example which does. I think it needs to be pretty early in the new user's reading flow, before they attempt to write their own component, and before they jump to reading the later pages.

Long term solution

At the moment, I think a large contributing factor is that the Hooks documentation is still mostly standalone from the rest of the docs. I think the combination of newness wearing off, and integration into the "main" docs will eventually solve this problem.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Revise as duas primeiras páginas da documentação de Hooks, especialmente os exemplos introdutórios e o quarto componente de exemplo, onde props aparecem pela primeira vez. Atualize um exemplo introdutório inicial, ou adicione um segundo, para demonstrar um componente de hook que consome props e deixar claro o uso para novos leitores.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript, react
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.