Home

Awesome

npm version All Contributors Commitizen friendly js-standard-style codecov Publish to NPM Netlify Status

React Awesome Styled Grid 😎

A responsive grid system for React using styled-components

Installation

npm i --save react-awesome-styled-grid

Dependencies

styled-components is a peerDependency and must be installed separately.

npm i --save styled-components

Documentation

Click here for documentation

Basic usage

This grid system is mobile-first based on Google Material Design.

Number of columns: xs: 4, sm: 8, md: 8, lg: 12, xl: 12

Breakpoints size: xs: > 1rem, sm: > 48rem, md: > 64rem, lg: > 90rem, xl: > 120rem

for a custom configuration, see this section of documentation

import { Container, Row, Col } from "react-awesome-styled-grid";

const MyCoolComponent = () => (
  <Container>
    <Row>
      <Col xs={4} md={2}>
        Col A
      </Col>
      <Col xs={6} md={10}>
        Col B
      </Col>
    </Row>
  </Container>
);

Development

run yarn install or npm install to install all dependencies

run yarn start or npm run start to run Docusaurus on port 3000

Go to http://localhost:3000/demo to see live demo and edit Demo.tsx file

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore --> <table><tr><td align="center"><a href="http://devchico.com"><img style="border-radius:50px" src="https://avatars3.githubusercontent.com/u/15852005?v=4" width="100px;" alt="Francisco Santos"/><br /><sub><b>Francisco Santos</b></sub></a><br /><a href="https://github.com/santosfrancisco/react-awesome-styled-grid/commits?author=santosfrancisco" title="Code">💻</a> <a href="https://github.com/santosfrancisco/react-awesome-styled-grid/commits?author=santosfrancisco" title="Documentation">📖</a> <a href="#review-santosfrancisco" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="http://camilaibs.wix.com/blog"><img style="border-radius:50px" src="https://avatars3.githubusercontent.com/u/6290749?v=4" width="100px;" alt="Camila Belo"/><br /><sub><b>Camila Belo</b></sub></a><br /><a href="https://github.com/santosfrancisco/react-awesome-styled-grid/commits?author=camilaibs" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/Fabioh"><img style="border-radius:50px" src="https://avatars0.githubusercontent.com/u/10605659?v=4" width="100px;" alt="Fábio Henrique Gabriele"/><br /><sub><b>Fábio Henrique Gabriele</b></sub></a><br /><a href="https://github.com/santosfrancisco/react-awesome-styled-grid/commits?author=Fabioh" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/BernardoMariano"><img style="border-radius:50px" src="https://avatars2.githubusercontent.com/u/3067157?v=4" width="100px;" alt="Bernardo Mariano"/><br /><sub><b>Bernardo Mariano</b></sub></a><br /><a href="https://github.com/santosfrancisco/react-awesome-styled-grid/commits?author=BernardoMariano" title="Code">💻</a></td><td align="center"><a href="https://github.com/ixahmedxi"><img style="border-radius:50px" src="https://avatars2.githubusercontent.com/u/20271968?v=4" width="100px;" alt="Ahmed Tarek"/><br /><sub><b>Ahmed Tarek</b></sub></a><br /><a href="https://github.com/santosfrancisco/react-awesome-styled-grid/commits?author=ixahmedxi" title="Code">💻</a></td><td align="center"><a href="https://github.com/zero0Halo"><img style="border-radius:50px" src="https://avatars0.githubusercontent.com/u/2113956?v=4" width="100px;" alt="Steve Swanson"/><br /><sub><b>Steve Swanson</b></sub></a><br /><a href="#maintenance-zero0Halo" title="Maintenance">🚧</a></td></tr></table> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!