react-native-css-media-query-processor

    0.21.3 • Public • Published

    React Native CSS Media Query processor

    Platform - Android and iOS NPM version Build Status Build status Coverage Status Size PRs Welcome

    Match style objects containing CSS Media Queries with React Native

    This library is based on React Native Extended StyleSheet's CSS Media Queries implementation.

    Installation

    npm install react-native-css-media-query-processor --save-dev
    

    or

    yarn add react-native-css-media-query-processor --dev
    

    Usage

    This library takes parsed CSS with media queries and matches it during runtime with React Native's current device dimensions and device orientation.

    To minimize runtime performance hit, the media queries must be parsed already before calling process function. Have a look at the example to see how the parsed syntax looks like.

    You can use this library together with css-to-react-native-transform to transform a string of CSS containing media queries to an React Native style object.

    Notice that there is no syntax validation for CSS media queries. This is done to ensure that the media query matching is as fast as possible. If you want to validate syntax for the media queries, you should do that when they are parsed to style objects (that's what css-to-react-native-transform does).

    Example

    Given that React Native returns the following dimensions:

    import { Dimensions } from "react-native";
    Dimensions.get("window");
    // => { width: 110, height: 100 }

    This is a simplified example of how the CSS gets transformed in to a React Native compatible style object:

    App.css:

    .foo {
      color: red;
      margin-top: 1px;
    }
     
    .bar {
      font-size: 1rem;
    }
     
    @media (min-width: 50px) and (max-width: 150px) {
      .foo {
        color: blue;
      }
      .bar {
        font-size: 2rem;
      }
    }

    ↓ ↓ ↓ ↓ ↓ ↓

    import styles from "./App.css";
    import transform from "css-to-react-native-transform";
     
    transform(styles, { parseMediaQueries: true });

    ↓ ↓ ↓ ↓ ↓ ↓

    const styleObject = {
      __mediaQueries: {
        "@media (min-width: 50px) and (max-width: 150px)": [
          {
            inverse: false,
            type: "all",
            expressions: [
              { modifier: "min", feature: "width", value: "50px" },
              { modifier: "max", feature: "width", value: "150px" }
            ]
          }
        ]
      },
      foo: {
        color: "red",
        marginTop: 1
      },
      bar: {
        fontSize: 16
      },
      "@media (min-width: 50px) and (max-width: 150px)": {
        foo: {
          color: "blue"
        },
        bar: {
          fontSize: 32
        }
      }
    };

    ↓ ↓ ↓ ↓ ↓ ↓

    import { process } from "react-native-css-media-query-processor";
    import { Dimensions } from "react-native";
     
    const win = Dimensions.get("window");
    const matchObject = {
      width: win.width,
      height: win.height,
      orientation: win.width > win.height ? "landscape" : "portrait",
      "aspect-ratio": win.width / win.height,
      type: "screen"
    };
     
    process(styleObject, matchObject);

    ↓ ↓ ↓ ↓ ↓ ↓

    {
      foo: {
        color: "blue",
        marginTop: 1
      },
      bar: {
        fontSize: 32
      }
    }

    Dependencies

    • deepmerge - A library for deep (recursive) merging of Javascript objects (UMD bundle is 593B minified+gzipped)
    • micro-memoize - A tiny, crazy fast memoization library for the 95% use-case

    Install

    npm i react-native-css-media-query-processor

    DownloadsWeekly Downloads

    2,510

    Version

    0.21.3

    License

    MIT

    Unpacked Size

    17.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • kristerkari