The Wayback Machine - http://web.archive.org/web/20201106135443/https://github.com/react-native-elements/react-native-elements/issues/2604
Skip to content

/ react-native-elements

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

Jump to bottom

Docs: Arrange props alphabetically #2604

Open
pranshuchittora opened this issue Sep 24, 2020 · 30 comments
Open

Docs: Arrange props alphabetically #2604

pranshuchittora opened this issue Sep 24, 2020 · 30 comments
Labels
📖 Docs Good First Issue Hacktoberfest

Comments

@pranshuchittora
Copy link
Member

@pranshuchittora pranshuchittora commented Sep 24, 2020 •
edited

The documentation of all components lists the props as well as their usage. It would be great if we arrange the props list alphabetically to make it easier to find the required props.

Just like the expo docs and others.

Proposed Fix
The docs are written using markdown and can be found here.

You can make multiple PRs (one PR for one component ) as it makes it easy to review. Considering the surface area of this issue.

As multiple peoples will be working on this issue, make sure to comment down the name of the component you will work on.

Progress

  • Avatar
  • Checkbox
  • Image
  • Tooltip
  • Header
  • Icon
  • Title
  • Slider
  • Modal
  • Badge
  • Button
  • Searchbar
  • ListItem
  • Pricing
  • Rating
@a-developer-and-her-mac
Copy link
Contributor

@a-developer-and-her-mac a-developer-and-her-mac commented Sep 24, 2020 •
edited

So this would be just rearranging the props list in each markdown file to be alphabetical? If so, this seems like a good first issue for me.
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Sep 24, 2020

Yeah @a-developer-and-her-mac the idea to make prop search more fast and intuitive for the mobile users as Find in a page takes a lot of clicks.
Thanks for taking this issue. Assigning it to you :)
@flyingcircle
Copy link
Collaborator

@flyingcircle flyingcircle commented Sep 24, 2020

Avatar was done in: #2605

I'm also fine if someone wants to do more than one component per PR if that is easier.
@a-developer-and-her-mac
Copy link
Contributor

@a-developer-and-her-mac a-developer-and-her-mac commented Sep 24, 2020

Alright, I'll try to do at least two per PR. If it's alright though, I might wait for a week so the rest can count towards Hacktoberfest.
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Sep 25, 2020

Removing all assignees as this is a big issue so multiple people can work on this simultaneously.
@mukuakhilesh
Copy link
Contributor

@mukuakhilesh mukuakhilesh commented Sep 25, 2020

As there can be multiple assignees, can I take up and edit few of the component's markdown files ?
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Sep 25, 2020

@mukuakhilesh go ahead :)
Pls, comment here about the components you will work upon, in order to avoid duplicate PRs.

@pranshuchittora pranshuchittora mentioned this issue Sep 25, 2020

Merged

@pranshuchittora pranshuchittora linked a pull request that will close this issue Sep 25, 2020

Docs: arrange props list in avatar.md to be alphabetical #2605
Merged
@mukuakhilesh
Copy link
Contributor

@mukuakhilesh mukuakhilesh commented Sep 25, 2020

I can work upon checkbox.md for now, if no one has started to work on it.
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Sep 25, 2020

Great, adding this to the issue description :)
@pranshuchittora pranshuchittora pinned this issue Sep 25, 2020
@ujjwal404
Copy link
Contributor

@ujjwal404 ujjwal404 commented Sep 25, 2020

@pranshuchittora , I made a pull request in which I arranged props of image.md file in order. Can you please check.

@pranshuchittora pranshuchittora linked a pull request that will close this issue Sep 25, 2020

Reaaranged props in docs #2607
Closed
@a-developer-and-her-mac
Copy link
Contributor

@a-developer-and-her-mac a-developer-and-her-mac commented Sep 26, 2020

I'll start working on badge.md and button.md.
@mukuakhilesh
Copy link
Contributor

@mukuakhilesh mukuakhilesh commented Sep 27, 2020

@pranshuchittora I have made a pull request for checkbox.md. Can you check it once.

@mukuakhilesh mukuakhilesh mentioned this issue Sep 27, 2020

Merged

@JB1905 JB1905 mentioned this issue Sep 27, 2020

Merged
@mukuakhilesh
Copy link
Contributor

@mukuakhilesh mukuakhilesh commented Sep 27, 2020

I will like to take up header.md and icon.md, if no one has started working on it.
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Sep 27, 2020

I will like to take up header.md and icon.md, if no one has started working on it.

Sure, Pls go ahead :)
@JB1905
Copy link
Contributor

@JB1905 JB1905 commented Sep 27, 2020

@pranshuchittora add Tooltip to Progress as done
@mbeuil
Copy link
Contributor

@mbeuil mbeuil commented Sep 29, 2020

Hey ! if nobody work on those can I take tile.md and slider.md ?
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Sep 30, 2020

Hey ! if nobody work on those can I take tile.md and slider.md ?

Sure

@mukuakhilesh mukuakhilesh mentioned this issue Sep 30, 2020

Merged
@mbeuil
Copy link
Contributor

@mbeuil mbeuil commented Oct 1, 2020

slider and tile were done in : #2619 .
(Don't know how to link a PR to an issue sorry -_-)
@ujjwal404
Copy link
Contributor

@ujjwal404 ujjwal404 commented Oct 1, 2020

I've made a pull request and sorted component in overlay.md file. #2622 .
@mukuakhilesh
Copy link
Contributor

@mukuakhilesh mukuakhilesh commented Oct 1, 2020

I will start work on pricing.md and rating.md, if no one has started on these.
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Oct 1, 2020

I will start work on pricing.md and rating.md, if no one has started on these.

Great. Go Ahead :)
@sanskritip
Copy link
Contributor

@sanskritip sanskritip commented Oct 6, 2020

I would like to work on searchbar.md and listitem.md if no one has started working on it!
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Oct 6, 2020

I would like to work on searchbar.md and listitem.md if no one has started working on it!

Ya sure, pls go ahead :)
@sanskritip
Copy link
Contributor

@sanskritip sanskritip commented Oct 6, 2020

I would like to work on searchbar.md and listitem.md if no one has started working on it!

Ya sure, pls go ahead :)

Made a PR - Docs: arrange props alphabetically in searchbar.md, listitem.md #2629 . Kindly review it :)
@dummy26
Copy link
Contributor

@dummy26 dummy26 commented Oct 7, 2020

Hi! Just made a PR - Arranged props alphabetically in pricing.md #2631.
@dummy26
Copy link
Contributor

@dummy26 dummy26 commented Oct 7, 2020

Is someone working on rating.md. If no, then I can take it up.
@pranshuchittora
Copy link
Member Author

@pranshuchittora pranshuchittora commented Oct 7, 2020

Hi @dummy26 thanks, I have merged your PRs.
@chas-e
Copy link

@chas-e chas-e commented Oct 17, 2020

I will alphabetize input.md's props.

@chas-e chas-e mentioned this issue Oct 17, 2020

Open
Nikodermus added a commit to Nikodermus/react-native-elements that referenced this issue Oct 24, 2020
@Nikodermus
chore(website/docs): arrange props list to be alphabetical
67a3f93 
Changed button, input and text.md

react-native-elements#2604

@Nikodermus Nikodermus mentioned this issue Oct 24, 2020

Open
@JiriJAdam
Copy link

@JiriJAdam JiriJAdam commented Oct 26, 2020

Hello! Can I work on this?
@PropeReferio
Copy link

@PropeReferio PropeReferio commented Oct 28, 2020 •
edited

Any other docs here that need help? I'd like to work on this.

Bottomsheet.md is already done, and can be added to progress checklist.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📖 Docs Good First Issue Hacktoberfest
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

Docs: arrange props list in avatar.md to be alphabetical
Reaaranged props in docs
You can’t perform that action at this time.