React-native-paper: Add missing screenshots of the components in the documentation.

Created on 14 Apr 2020  路  7Comments  路  Source: callstack/react-native-paper

Couple components are missing the screenshots in the documentation. We should provide nice-looking screenshots that will improve the developer experience.

The first part of the ticket is to find out which components are missing screenshots.
The second part is to create them.

Stale docs good first task

Most helpful comment

I've created a PR with screenshots that I find missing in docs. For some components, I've decided not to add a new screenshot, as there is another image in the given section that already presents the component.

All 7 comments

Showing the component rather than a screenshot could be another approach.

Perhaps using something like react-native-web

Screenshot List

  • [x] ActivityIndicator

  • [x] Appbar

  • [ ] Appbar.Action
  • [ ] Appbar.BackAction
  • [ ] Appbar.Content
  • [x] Appbar.Header

  • [ ] Avatar

  • [x] Avatar.Icon
  • [x] Avatar.Image
  • [x] Avatar.Text

  • [x] Badge

  • [x] Banner

  • [x] BottomNavigation

  • [x] Button

  • [x] Card

  • [ ] Card.Actions
  • [ ] Card.Content
  • [ ] Card.Cover
  • [x] Card.Title

  • [x] Checkbox

  • [x] Checkbox.Android
  • [x] Checkbox.IOS

  • [x] Chip

  • [x] DataTable

  • [ ] DataTable.Cell
  • [ ] DataTable.Header
  • [ ] DataTable.Pagination
  • [ ] DataTable.Row
  • [ ] DataTable.Title

  • [x] Dialog

  • [ ] Dialog.Actions
  • [ ] Dialog.Content
  • [ ] Dialog.ScrollArea
  • [ ] Dialog.Title

  • [x] Divider

  • [ ] Drawer

  • [ ] Drawer.Item
  • [ ] Drawer.Section

  • [x] Fab

  • [x] FAB.Group

  • [x] HelperText

  • [x] IconButton

  • [ ] TouchableRipple

  • [ ] List

  • [x] List.Accordion
  • [x] List.AccordionGroup
  • [ ] List.Icon
  • [x] List.Item
  • [x] List.Section
  • [x] List.Subheader

  • [x] Menu

  • [ ] Menu.Item

  • [ ] Modal

  • [ ] Portal

  • [ ] Portal.Host

  • [x] ProgressBar

  • [x] RadioButton

  • [x] RadioButton.Android
  • [ ] RadioButton.Group
  • [x] RadioButton.IOS
  • [x] RadioButton.Item

  • [x] Searchbar

  • [x] Snackbar

  • [x] Surface

  • [x] Switch

  • [x] TextInput

  • [x] ToggleButton

  • [ ] ToggleButton.Group
  • [ ] ToggleButton.Row

  • [ ] Typography

  • [ ] Text
  • [x] Subheading
  • [x] Title
  • [x] Paragraph
  • [x] Headline
  • [x] Caption

@cmargieson Yeah, I agree. Ideally, we would like to have a "live preview", but this requires a lot more work and we don't have that much capacity at this moment. That's why we want to provide missing screenshots for now.

And thanks for making the list, it's really helpful <3

I was going to make a new thread, but thought I might as well tack on to this issue.

chip ui elements

The documentation states

Both icon and avatar cannot be specified.

However the image above shows Chips with both avatars and icons. I consider that the Icon's in the avatar Chip's may simple be nested icons, however the documentation could better articulate this by providing an example as per the included pictures.

Thanks for the feedback @Trancever, I'm glad the list us useful!

I'd like to see how live previews could be implemented. Do you mind if I try to come up with a PR?

I've created a PR with screenshots that I find missing in docs. For some components, I've decided not to add a new screenshot, as there is another image in the given section that already presents the component.

@cmargieson Yeah, we are always happy to accept PRs from external contributors!

Hello 馃憢, this issue has been open for more than 2 months with no activity on it. If the issue is still present in the latest version, please leave a comment within 7 days to keep it open, otherwise it will be closed automatically. If you found a solution on workaround for the issue, please comment here for others to find. If this issue is critical for you, please consider sending a pull request to fix the issue.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ZhengYuTay picture ZhengYuTay  路  3Comments

tonyxiao picture tonyxiao  路  3Comments

makhataibar picture makhataibar  路  4Comments

scottybo picture scottybo  路  3Comments

mihaidaviddev picture mihaidaviddev  路  3Comments