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

eventKey and key documentation #432

Closed
RichardLitt opened this issue Mar 4, 2015 · 7 comments
Closed

eventKey and key documentation #432

RichardLitt opened this issue Mar 4, 2015 · 7 comments
Labels

Comments

@RichardLitt
Copy link
Contributor

The documentation around eventKey and key is confusing or missing, as noted in #320. I would like to make a PR to fix this, but I am unclear on a few areas.

Is eventKey only used in react-bootstrap, or is it also standard in react? cc @trentgrover-wf

@trentgrover-wf
Copy link
Contributor

eventKey is a react-bootstrap concept only. key is the standard React concept, but key values are no longer available for use within a component, so we had to switch to using a separate explicit value for some use cases (hence the birth of eventKey)

@RichardLitt
Copy link
Contributor Author

Ok. Is there a place we can document this, besides here?

@trentgrover-wf
Copy link
Contributor

should probably just be documented alongside the relevant component examples (e.g. something to the effect of DropdownButton has an optional onSelect property...the onSelect function will receive the eventKey value of the selected MenuItem as a parameter...

@mtscout6
Copy link
Member

mtscout6 commented Mar 4, 2015

Something to take into account with #419

@RichardLitt
Copy link
Contributor Author

I'm not sure that that is what is best - eventKey doesn't only interact with onSelect, and it occurs in 21 different examples, not just in DropdownButton. There should be a warning somewhere about what eventKey is - I don't see where it would go on the Component page, but just including it in DropdownButton and then only when dealing with onSelect is limiting in scope.

The Components page is great, but I'm not sure that this sort of thing belongs there - it seems too general. If it does, it should be at the top, somewhere clear to explain what it is. What do you think?

@mtscout6 mtscout6 added enhancement help wanted docs Documentation related labels Mar 10, 2015
@mtscout6
Copy link
Member

Should we decide to go with #431 than this gets easy.

@dozoisch dozoisch added this to the 1.0.0 Release milestone May 3, 2015
@AlexKVal AlexKVal removed this from the 1.0.0 Release milestone Jun 29, 2015
@AlexKVal
Copy link
Member

Superceded by #419

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants