Prestyles

A simple little package that makes writing cross-platform responsive RN styles a bit tidier.

Installation

yarn add prestyles

Usage (createStyles)

1. Import the library

   import createStyles from 'prestyles';

2. Use this function where you would normally use StyleSheet.create();

3. This library allows you to add sub objects to your style objects that contain platform specific styles.

   const styles = createStyles({
      button: {
          backgroundColor: 'red',
          web: {
              backgroundColor: 'blue'
          }   
      }
   });

   Consume your styles as normal:

   <Button style={styles.button}/>

   The supported platform keys are:

   • web (only used on web)
   • native (used on ios and android)
   • ios (used on ios)
   • android (used on android)

4. This library also allows you to pass params to your style objects

   const styles = createStyles({
      button: (color) => ({
          fontSize: 12,
          color: color,
          native: {
              fontSize: 10
          }
      })
   });

   Consume:

   <Button style={styles.button('red')}/>

Usage (responsiveStyles)

1. Configure your breakpoints at top level App.js or wherever. (If you skip this step these are the default breakpoints)

   import {setBreakpoints} from 'prestyles';
   
   setBreakpoints({
       desktop: 1024, // min width,
       tablet: 768, // min width
       mobile: 0
   });

2. Import the style creator and hook

   import createStyles, {
      useResponsiveStyles
   } from 'prestyles';

3. Create styles with breakpoint sub styles

   const styles = createStyles({
      container: {
          backgroundColor: 'white', // Will be shown if no matching breakpoint
          desktop: {
              backgroundColor: 'blue' // Will be show on > 1024 widths
          },
          tablet: {
              backgroundColor: 'red'
          },
          mobile: {
              backgroundColor: 'green'
          }   
      }
   });

4. Use the useResponsiveStyles hook to consume styles that will dynamically change based on matching breakpoints

   const Foo = () => {
      const [responsiveStyles] = useResponsiveStyles(styles);
   
      return (
          <View style={responsiveStyles.container}/>
      )  
   }

5. The useResponsiveStyles hook accepts three params.

   1. The required styles object generated from createStyles
   2. A boolean to enable/disable the styles to spill over (upwards). Read section about this.
   3. An optional custom breakpoint object that will overwrite whatever was set at top-level with setBreakpoints

6. The useResponsiveStyles hook returns an array with 3 values:

   1. The parsed styles
   2. A boolean letting you know if the styles are ready (in cased you experience any flicker between the default styles, and the matched styles on load).
   3. An updated screen with value if you need it for anything

7. All breakpoints will be compared with >= (larger than or equal), this means styles will overflow upwards. IE tablet will inherit mobile styles, and desktop will inherit tablet styles. You can prevent this by either passing false as the second to the useResponsiveStyles hook, or by declaring your styles as exact match only by prefixing them with an underscore. _mobile will only render on mobile, _tablet only on desktop. You can also prefix your custom breakpoints the same way.