media-style-sheet
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

media-style-sheet

Media Query Extension to React-Native StyleSheets

This is a drop and replace for StyleSheet.create that allows you to create custom MediaQuery like options to dynamically apply styles.

Install

yarn

yarn add media-style-sheet

npm

npm install media-style-sheet

Usage

First create your MediaStyleSheet using createMediaStyleSheet providing your own mediaQuery types and functions.

This example uses a tablet and mobile media query

import { createMediaStyleSheet } from 'media-style-sheet';
import { isTablet, isMobile } from './device';

export const MediaStyleSheet = createMediaStyleSheet({
    tablet: () => isTablet(),
    mobile: () => isMobile(),
});

Then you can use it just like a regular StyleSheet

import { Text, View } from 'react-native';
import { MediaStyleSheet } from './MediaStyleSheet';

function HelloText(props: { name: string }) {
    return (
        <View style={styles.container}>
            <Text>Hello</Text>
            <Text>{props.name}</Text>
        </View>
    );
}

const styles = MediaStyleSheet.create({
    container: {
        justifyContent: 'center', // shared between both tablet and mobile styles
        tablet: {
            flexDirection: 'row',
        },
        mobile: {
            flexDirection: 'column',
        },
    },
});

This will provide a column based layout on mobile and a row based layout on tablet.

Documentation

createMediaStyleSheet

Creates a class MediaStyleSheet that is a thin wrapper around StyleSheet that includes MediaQuery like dynamic styles.

Parameters

  • mediaOptions: object that is a map of a mediaOptionKey to a mediaQuery
    • mediaOptionKey: string of mediaOption to use in your stylesheet
    • mediaQuery: function that returns true if mediaOption should be applied to style

example: For MediaOptions tablet and mobile you would pass { tablet: () => isTablet(), mobile: () => isMobile() }

Returns

MediaStyleSheet class that has the following properties:

  • create: Thin wrapper around StyleSheet.create with the added behavior of applying styles based on the mediaOptions passed in and whether their mediaQuery functions return true.
    • Note: If multiple mediaQuery function returns true, the last one will override any previously defined styles in the merge

Using mediaOptions tablet and mobile

We found using the library react-native-device-info an easy way to create an implementation of isTablet and isMobile.

import DeviceInfo from 'react-native-device-info';

export function isTablet(): boolean {
    return DeviceInfo.isTablet();
}

export function isMobile(): boolean {
    return !isTablet();
}

Readme

Keywords

none

Package Sidebar

Install

npm i media-style-sheet

Weekly Downloads

0

Version

1.0.2

License

MIT

Unpacked Size

12.4 kB

Total Files

7

Last publish

Collaborators

  • kodyfintak