Wondering what’s next for npm?Check out our public roadmap! »

    styled-wind
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.0-beta.14 • Public • Published

    Styled-wind

    A magical implementation of tailwind-like classnames into styled-components.

    GitHub Workflow Status Prettier Jest

    What is styled wind?

    Styled-wind is a CSS-in-JS library, written on top of styled-components. It inherits everything from styled-components and also gives you the flexibility to use tailwind classnames along with styled-components. Read the docs to know more.

    Motivation

    Styled-components is one of the most famous CSS-in-JS library and has been favorite styling tool in the React ecosystem. On the other hand, tailwind css has gained a lot of momentum recently because of the ease of use and quick development of responsive web apps. However, there are few practical issues in using tailwind css. This library is an attempt to get the best of both worlds.

    See the Quick start guide for more details.

    Why styled-wind?

    • Building Responsive sites becomes a lot easier
    • Very small bundle size to use in existing projects
    • 2 minutes migration to use tailwind in a styled-component project
    • Solving the readability issues of tailwind
    • Build reusable components / UI libraries
    • Dynamic styling using props
    • Benefits of tailwind in Component world of React & Styled-components
    • Remembering or writing CSS is not required
    • Tailwind like development for React Native

    Prerequisite

    Basic knowledge of styled-components and tailwindcss. The list of tailwind class names can be found here

    Features

    • Zero-CSS
    • Responsive
    • Custom Styling/Theme
    • No class name bugs
    • Development speed
    • Automatic critical CSS
    • Easier maintenance of CSS
    • Automatic vendor prefixing
    • Simple dynamic styling
    • Tailwind is not required

    Roadmap/TODO:

    Contributions & Suggestions welcome

    • Auto intellisense, syntax highlighting and linting
    • Support for React Native
    • Allowing tailwind classes inside prop's conditions
    • CLI/Context for consuming custom styling
    • Add support for animation classes
    • Optimize the library

    Caveats

    • React Native support is not added yet

    • Tailwind classnames aren't supported yet inside keyframes and expressions. However you may still use regular CSS for expressions & keyframes

      // Not allowed. Will be implemented in future
      const StyledComponent = styled.div`
              @keyframes mymove{
                  from { .top-10 }
                  to { .top-16 }
              }
          `;
      
      // Allowed
      const StyledComponent = styled.div`
        @keyframes mymove {
          from {
            top: 0px;
          }
          to {
            top: 200px;
          }
        }
      `;
    • Animation classes aren't supported yet.

    • Custom theme can currently be configured only inside index.html file

    • No support for variants as we find no dominant use case in component world

    • Please report if you happen to find any issues.

    Examples

    Check out the CodeSandBox to see styled-wind in use.

    Community

    The creators of the library are always open to discussions/suggestions. Their twitter accounts:

    Contributors

    Thanks goes to these awesome people for their wonderful contributions!


    Ameer Jhan


    Vilva Athiban P B


    Sudharsan


    Shashank Bairy R


    Yash Joshi


    Vignesh Elangovan


    Nithish D

    License

    MIT © Product Ride

    Install

    npm i styled-wind

    DownloadsWeekly Downloads

    9

    Version

    0.0.0-beta.14

    License

    MIT

    Unpacked Size

    394 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar
    • avatar