Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Have more details about FormControl, FormGroup etc. #8159

Closed
slavab89 opened this issue Sep 12, 2017 · 4 comments
Closed

[docs] Have more details about FormControl, FormGroup etc. #8159

slavab89 opened this issue Sep 12, 2017 · 4 comments
Assignees
Labels
docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process.

Comments

@slavab89
Copy link
Contributor

slavab89 commented Sep 12, 2017

So i've been trying to understand what are the different From* components are used for and what are the differences between them and what i should use with what.
I was forced to go to the source to actually understand what they do.

Should we have a more detailed information about those components? The documentation on the API doc is pretty minimal
Currently they are used in several examples yet i didnt fully understand their purpose.

For example, in the checkbox example all the checkboxes are placed in a FormGroup. They can be placed in a FormControl as well with a FormLabel (am i correct?), yet if i put a disabled prop on FormControl, the checkboxes are not disabled. Not sure if that's intended or not

<FormControl disabled>
  <FormLabel component="legend">Header</FormLabel>
  <FormControlLabel control={<Checkbox value="A"} label="A" />} />
</FormControl>
@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation v1 good first issue Great for first contributions. Enable to learn the contribution process. labels Sep 12, 2017
@oliviertassinari oliviertassinari self-assigned this Sep 16, 2017
oliviertassinari added a commit that referenced this issue Sep 16, 2017
- [docs] Fix broken url link
- [Popover] Remove unsupported modal property from the Popover component that doesn't match his role.
Closes #8202
- [Tooltip] Add accessibility support
- [Tooltip] Rename label to title property to match HTML feature wording
- [Tooltip] Add a warning when using the title native feature at the same time
- [Form] Extend the description of the component. It's not perfect, still is better.
Closes #8159
- [Menu] Second iteration on focus issue
Closes #8169
@oliviertassinari
Copy link
Member

I have added more information to the API pages. It's better but not perfect.

@Gems
Copy link

Gems commented May 16, 2019

I believe the example mentioned above would be useful to have on the FormControl documentation page.

@oliviertassinari
Copy link
Member

@Gems Do you want to add such an example for the composition of the form input elements?

@Gems
Copy link

Gems commented May 27, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process.
Projects
None yet
Development

No branches or pull requests

3 participants