twx-rn v1.0.3

Twx

A tiny utility for constructing styles object using tailwind-rn for your ReactNative projects. It uses the infamous clsx package behind the hood for generating className strings conditionally.

Install

yarn add twx-rn
# or
npm install twx-rn

Getting Started

The twx generates the styles object using the tailwind-rn library, so you need to have it installed and configured.

yarn add tailwind-rn
# or
npm install tailwind-rn

npx setup-tailwind-rn # Generate the config file

See full documentation.

Usage

The twx() supports all the conditions as the clsx package, see here.

Basic usage

import twx from 'twx-rn';
// or
import { twx } from 'twx-rn';

<View style={twx("text-white mt-1", true && "bg-black")}>Hello Tailwind!</View>

Recommended Usage

This example is in Typescript

How?

Define type for your react native components

// types.ts

import { ViewProps } from "react-native";

export type ComponentProps<T> = {
  style?: ViewProps["style"];
  children?: React.ReactNode;
  className?: string;
} & T;

export interface Component<T = {}> extends React.FC<ComponentProps<T>> {}

Create a HOC

// with-class-name.tsx

import { Component, ComponentProps } from "@appTypes/.";
import twx from "twx-rn";

const withClassName =
  <T,>(C: Component<T>) =>
  (props: ComponentProps<T>) => {
    const { style, className } = props;
    return <C {...props} style={[style, twx(className)]} />;
  };

export default withClassName;

Create your component

// HR.tsx

import { Component } from "@appTypes/.";
import { View } from "react-native";
import twx from "twx-rn";
import withClassName from "@hoc/with-class-name";

type Props = {
  // your extra props
}

const HR: Component<Props> = ({ style }) => {
  return <View style={[twx("h-[1px] w-full bg-black"), style]} />;
};

export default withClassName<Props>(HR);

Use your component

// App.tsx

<HR className="bg-white" />
// or
<HR style={twx("bg-white")} />

Why?

• Better code readability
• Easier migration from React code
• IDE class name recommendations start working

Contribution

See a place where you can improve? See a grammatical mistake? Or want to add a entirely new feature?

All is welcomed, feel free to raise a Pull Request or create and Issue :)