Semantic-Org/Semantic-UI-React

Advertise all underlying propTypes and typings in wrapper components

Open

Aperta il 16 gen 2017

Vedi su GitHub
 (20 commenti) (0 reazioni) (0 assegnatari)JavaScript (13.136 star) (4065 fork)batch import
docsgood first issuehelp wanted

Descrizione

See #1163 for the inspiration here.

Some components wrap others, like a Popup wrapping a Portal. However, we do not advertise the Portal props as propTypes nor typings of the Popup. This means there is no way for users to know what props are available.

Add propTypes

I propose we explicitly list all known props in propTypes and typings of the underlying component when a component wraps another component.

Add Examples

We should then also add doc site examples showing use of these props. Example, Popup mouse enter/leave delays are not shown but are available as it composes the Portal which has mouse enter/leave delays.

Task List

Here is a brain dump of wrapper components, there may be more. @jcarbo / @layershifter feel free to update this list at will:

  • Popup -> Portal
  • Modal -> Portal
  • Confirm -> Modal
  • Select -> Dropdown
  • Radio -> Checkbox
  • Table.Footer -> Table.Header
  • Table.HeaderCell -> Table.Cell
  • Form.Button -> FormField + Button
  • Form.Checkbox -> FormField + Checkbox
  • Form.Dropdown -> FormField + Dropdown
  • Form.Input -> FormField + Input
  • Form.Radio -> FormField + Radio
  • Form.Select -> FormField + Select
  • Form.TextArea -> FormField + TextArea

Guida contributor

Tech stack
javascriptreacttypescript
Dominio
frontenddocumentation
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
over 1 week
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
ReactJavaScriptSemantic UI ReactpropTypes
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
The issue lists wrapper components like Popup wrapping Portal. For each, examine the underlying component's propTypes and typings, then add them to the wrapper. Also, add doc site examples. Start with the Popup >Portal pair; look at Popup.js and Portal.js in the source to see current props. Follow patterns from other similar additions. Check existing PRs or comments for guidance.