Automatic codemods to upgrade your styled-components code to newer versions.

License: MIT License

JavaScript 100.00%

styled-components-codemods's Introduction

Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress 💅

Upgrading from v5? See the migration guide.

Utilizing tagged template literals (a recent addition to JavaScript) and the power of CSS, styled-components allow you to write actual CSS code to style your components. It also removes the mapping between components and styles – using components as a low-level styling construct could not be easier!

const Button = styled.button`
  color: grey;
`;

Alternatively, you may use style objects. This allows for easy porting of CSS from inline styles, while still supporting the more advanced styled-components capabilities like component selectors and media queries.

const Button = styled.button({
  color: 'grey',
});

Equivalent to:

const Button = styled.button`
  color: grey;
`;

styled-components is compatible with both React (for web) and React Native – meaning it's the perfect choice even for truly universal apps! See the documentation about React Native for more information.

Supported by Front End Center. Thank you for making this possible!

Docs

See the documentation at styled-components.com/docs for more information about using styled-components!

Quicklinks to some of the most-visited pages:

Example

import React from 'react';

import styled from 'styled-components';

// Create a <Title> react component that renders an <h1> which is
// centered, palevioletred and sized at 1.5em
const Title = styled.h1`
  font-size: 1.5em;
  text-align: center;
  color: palevioletred;
`;

// Create a <Wrapper> react component that renders a <section> with
// some padding and a papayawhip background
const Wrapper = styled.section`
  padding: 4em;
  background: papayawhip;
`;

function MyUI() {
  return (
    // Use them like any other React component – except they're styled!
    <Wrapper>
      <Title>Hello World, this is my first styled component!</Title>
    </Wrapper>
  );
}

This is what you'll see in your browser:

Screenshot of the above code ran in a browser

Looking for v5?

The main branch is for the most-current version of styled-components, currently v6. For changes targeting v5, please point your PRs at the legacy-v5 branch.

Built with `styled-components`

A lot of hard work goes into community libraries, projects, and guides. A lot of them make it easier to get started or help you with your next project! There are also a whole lot of interesting apps and sites that people have built using styled-components.

Make sure to head over to awesome-styled-components to see them all! And please contribute and add your own work to the list so others can find it.

Contributing

If you want to contribute to styled-components please see our contributing and community guidelines, they'll help you get set up locally and explain the whole process.

Please also note that all repositories under the styled-components organization follow our Code of Conduct, make sure to review and follow it.

Badge

Let everyone know you're using styled-components →

[![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components)

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

License

See LICENSE for more information.

Acknowledgements

This project builds on a long line of earlier work by clever folks all around the world. We'd like to thank Charlie Somerville, Nik Graf, Sunil Pai, Michael Chan, Andrey Popp, Jed Watson & Andrey Sitnik who contributed ideas, code or inspiration.

Special thanks to @okonet for the fantastic logo.

styled-components-codemods's People

Contributors

Stargazers

Watchers

Forkers

stevenlangbroek jcarroll2007 isabella232 grumd

styled-components-codemods's Issues

Automatically add TS types if typescript is detected in package.json

Not sure if this falls into codemod territory, but might be a cool thing to add

Difficult to know progress, or if finished

I'm migrating to v4 and running this mod on a pretty large directory at once. So will probably take some time. I just want to be sure that it's still running, it just says

npx: installed 356 in 8.264s

innerRef -> ref

Doesn't work on Windows

Hi Team!

FYI this codemod does not work on Windows.
Switched on Unix, worked like a charm :)

Cheers

use a globbing library

styled-components-codemods v4 src/**/*.js (this will only work if your terminal expands globs)

We should just bring in a globbing lib and do it no matter what the terminal is. Need to make sure the separators are right for win vs *nix

Add instructions to remove thrown error after complete with the migration.

I wasn't sure what to do after running the script. The error kept popping up and my browser reported a server error. I know this is likely a silly mistake, but I'm new to Styled Components and didn't want too break anything with this script.

Therefore, I propose an additional sentence to add to the createGlobalStyles warning. Something along the lines of " Once you have hooked it up, feel free to remove this error from your code.';"

I tried adding a branch but it's locked down.

Anyhow, thanks for doing the work on this codemod. It made life easier!

No changes to files after running against files containing `.extend`

Maybe I'm missing something very obvious, but when I use this codemod as described in the README against files using the .extend API, those files remain unchanged.

NPM version: 6.10.2
Node version: v8.12.0
OS: macOS 10.13.6

Would you need any other information?

Thanks for making this!

New codemod to prefix transient prop names with $

I can't tell if this repo is still active, but I'll post this here anyway.

With styled-components v6, automatic prop filtering was dropped, meaning props that should not be forwarded to the underlying DOM elements should be prefixed with a $. Doing this manually is extremely tedious and laborious.

Performing this rename seems like something that a codemod should be able to do. It might not get everything completely right (i.e. devs should still probably look over the changes it makes), but it should be able to at least find all of the places in code where a $ prefix may need to be added.

Is this something someone here could create? I've never written a codemod before.

[feature request] CodeMod to covert React Native StyleSheet to styled-components

[feature request] Please can we have a codemod that will automatically convert a React Native project from using StyleSheet.create to styled-components? A sort of opposite to https://github.com/styled-components/css-to-react-native ?

Use case:

John the developer has a React Native app. He used the built in React Native StyleSheet.create method for CSS styling. John also makes websites. John keeps on accidentally using the wrong syntax in React Native because it is similar but slightly different to web css syntax. (A UX mode error.) John wastes a lot of expensive developer time fixing these syntax errors. Particularly terminating a line of css with a semicolon ; when it should be a comma , or vice versa. John then shouts at his partner. John kicks the dog.

John then runs a codemod to convert his React Native code to use styled-components. John now uses the same css syntax when writing apps and websites. John makes less syntax errors. John always terminates a line of css with a semi-colon. John is happy. In the time freed up by not having to fix syntax mode errors John investigates writing universal apps using react-native-web or similar. John is productive. John proposes to his partner. John gives his dog a bone. They all live happily ever after.

styled-components / styled-components-codemods Goto Github PK

styled-components-codemods's Introduction

Example

Looking for v5?

Built with styled-components

Contributing

Badge

Contributors

Backers

Sponsors

License

Acknowledgements

styled-components-codemods's People

Contributors

Stargazers

Watchers

Forkers

styled-components-codemods's Issues

Recommend Projects

Recommend Topics

Recommend Org

Built with `styled-components`