@rbxts/rowindcss
TypeScript icon, indicating that this package has built-in type declarations

1.3.1 • Public • Published

RowindCSS

TailwindCSS classes for Roact & Roblox-ts.

Getting Started

Install using:

yarn add @rbxts/rowindcss

or

npm i @rbxts/rowindcss

Install Tailwind configs in your project root for autocomplete

npx tailwindcss init
/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    "./src/**/*.tsx",
    "./src/**/**/*.tsx",
    "./src/**/**/**/*.tsx"
],
  theme: {
    extend: {},
  },
  plugins: [],
}

Import the available Rowind components and start using them in Roact with Tailwind classes.

    import { Div, Button, Text } from '@rbxts/rowindcss'

    export const Test = () => {
        return (
            <Div className="w-full h-48 p-10 border-4 overflow-y border-red-700 border-opacity-50 flex justify-center items-end gap-3 top-2/4 left-2/4 rounded-xl bg-blue-500">
                <Div className="w-10 h-10 rounded-sm"/>
                <Div className="w-10 h-10 rounded-lg bg-yellow-300"/>
                <Div className="w-10 h-10 bg-green-700"/>
                <Button Event={{
                  MouseButton1Click: () => {
                    print("clicked")
                  }
                }}
                Text="X" className="w-10 h-10 rounded-full bg-red-700"/>
                <Text Text="Y" className="w-10 h-10 rounded-full bg-purple-800"/>
            </Div>
        )
    }

Refer to the tailwind documentation for class names. https://tailwindcss.com/

Currently supported Tailwind classes:

  • Flex (align-items, justify-content, gap, flex-direction)
  • Background (colour)
  • Border (size, colour, transparency, radius)
  • Font (weight)
  • Positioning (Left, Top, Right, Bottom)
  • Origin (anchor point)
  • Padding
  • Text (size, colour)
  • Size (width, height)
  • Aspect Ratio Experimental:
  • Overflow (overflow-x, overflow-y)

FAQ

How to attach references? You can use the 'ref' property of any Rowind component.

<Button ref={yourRef}/>

Readme

Keywords

none

Package Sidebar

Install

npm i @rbxts/rowindcss

Weekly Downloads

1

Version

1.3.1

License

MIT

Unpacked Size

87.9 kB

Total Files

65

Last publish

Collaborators

  • yayashn