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

Update the FlatList Component in Lists #41

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ayushjainrksh
Copy link
Member

Fixes #32

Summary

  • Update the title, prop descriptions and method descriptions from docs.
  • Add SnackPlayer examples with example annotation.
  • Add inherits annotation for the inherited link.
  • Remove unnecessary asterisks in comments.

@ayushjainrksh ayushjainrksh added the documentation Improvements or additions to documentation label Jun 17, 2020
@ayushjainrksh ayushjainrksh self-assigned this Jun 17, 2020
@ayushjainrksh
Copy link
Member Author

Problem

The documentation contains some props that are not defined in the code.

Example

A few examples would be:
Screenshot from 2020-06-17 15-34-58

Possible Solution

  • These props can be added in the flow type with documentation in the comments(just like all other props).

Copy link

@jevakallio jevakallio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment to improve the faded edge docs, but otherwise LGTM!

@jevakallio
Copy link

jevakallio commented Jun 17, 2020

Problem

The documentation contains some props that are not defined in the code.

Example

A few examples would be:
Screenshot from 2020-06-17 15-34-58

Possible Solution

  • These props can be added in the flow type with documentation in the comments(just like all other props).

@ayushjainrksh these component props are defined on the underlying VirtualizedList. The documentation for FlatList states "This is a convenience wrapper around , and thus inherits its props (as well as those of ) that aren't explicitly listed here".

I would read this to mean that these props should not be documented here. From the point of view of the documentation reader it might be useful to have better indication in the docs what props are being inherited from other components, so that the developer knows they can be passed to this component.

I think best way forward is to remove these for now, and create a new issue for improving inherited prop visibility overall. Thoughts @motiz88?

* Update the title, prop descriptions and method descriptions from docs.
* Add SnackPlayer examples.
* Remove unnecessary asterisks in comments.
* Wrap comments to 80 characters
* Add description to method FlowTypes
* Add prop types with type annotation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the FlatList component
2 participants