Skip to content

README.md

Latest commit

 

History

History
79 lines (70 loc) · 2.16 KB

README.md

File metadata and controls

79 lines (70 loc) · 2.16 KB
Raw

react-native-components

React Native component library for components used by React Native applications of Observation.org. There are 2 kinds of components: UI components:

  • Accordion
  • BackButton
  • BackgroundImage
  • BottomActionBar (+ BottomActionBarProps)
  • BottomSheet: Deprecated, use BottomActionBar
  • BottomSheetWithSearchInput
  • BrandIcon
  • BrandIcons
  • CapitalizeText
  • Checkbox
  • Chip
  • ContentImage
  • Date
  • DateFromToFilter
  • DatePicker
  • Disclose
  • DocumentLink
  • FilterButton
  • FilterOption
  • FilterSelectField
  • HtmlContent (+ HtmlContentProps, CustomRendererProps, RenderersProps, TBlock)
  • Icon
  • IconButton
  • IconName
  • IconText
  • IconView
  • Icons
  • InputField
  • InputPanel
  • ItemSeparator
  • LargeButton (+ LargeButtonProps)
  • Lightbox
  • ListItem
  • Location
  • Message
  • MoreInfo
  • Notification
  • NotificationPopup (+ NotificationPopupStaticProps)
  • PageIndicator
  • Panel
  • Popup
  • ProgressBar
  • ProgressBarList
  • Rarity
  • RaritySlider
  • SectionHeader
  • SingleLine
  • TextLink
  • Tooltip (+ TooltipProps)
  • WebLink

non-UI components:

  • Log.setLogConfiguration: A function to change the logging of the component library
  • openUrl: Opens URLs
  • SnackbarReporterContext (+ SnackbarReporter): Context through which a screen reports bottom insets and open modals to the app's snackbar
  • useBottomSheetBackHandler: A hook to close a BottomSheet on the Android hardware back button
  • useReportSnackbarInset: A hook to report the height of a UI element at the bottom of the screen, so a snackbar is shown above it
  • useShowBlurView: A safe way to set a blur on the background

Additionally, the package exposes two subpath entry points:

react-native-components/theme:

  • ThemeProvider, useTheme, useStyles
  • createTheme, defaultTheme: The default theme with colors, margins, text styles, shadows, and the surface and elevation an app uses for specific roles

react-native-components/styles:

  • font, fontSize, lineHeight: Font styles
  • layout, rounded: Layout styles
  • shadow: Deprecated, use theme.shadow
  • createInputStyles, createBottomSheetStyles