Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/styled-components/styled-elements
Styled components for the DOM.
https://github.com/styled-components/styled-elements
dom styled-components yo-yo
Last synced: 20 days ago
JSON representation
Styled components for the DOM.
- Host: GitHub
- URL: https://github.com/styled-components/styled-elements
- Owner: styled-components
- License: mit
- Created: 2017-02-04T21:45:13.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-20T22:39:06.000Z (over 5 years ago)
- Last Synced: 2024-10-08T10:16:44.370Z (about 1 month ago)
- Topics: dom, styled-components, yo-yo
- Language: JavaScript
- Size: 46.9 KB
- Stars: 87
- Watchers: 6
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## styled-elements
A super tiny DOM equivalent of [`styled-components`](https://github.com/styled-components/styled-components).
## Install
```
npm install --save styled-elements
```
## Usage
```js
import styled from 'styled-elements';
const Header = styled.h2`
color: #333;
`;
const MyButton = styled.button`
padding: 10px;
border-radius: ${0}px;
background: #F1F1F1;
&:hover {
background: #555;
}
`;
const Wrapper = styled.div`
width: 500px;
border: 1px solid #aaa;
@media (min-width: 400px) {
width: 100%;
background: #F1F1F1;
}
`;
document.body.appendChild(Wrapper(
Header('My header!'),
MyButton({ onclick: () => console.log('yay!') },
'Do Something',
'Say Something Else'
)
));
```
## Features
- Super tiny **2.1kb** gzipped
- Completely DOM based
- Supports `@media`
- Supports `@keyframes` (via `keyframes` method)
- Supports pseudo CSS (i.e. `&:hover`)
- State can be fed in through primitive methods (i.e `props => ...`)
- No dependencies
- Uses template literals and real CSS
- Supports all DOM elements
- Auto CSS class injection/management
- Works well with `yo-yo`, `bel` and `choo`
## About
I love `styled-components` and needed a DOM equivalent for a project. This is the result. It functions almost the same with pseudo and media queries supported. Dynamic props can be fed in through primitive functions; the output of each is a function where props can be fed in, which then returns another function where child elements and strings can be fed in.
A special thanks to [Max Stoiber](https://twitter.com/mxstbr) and the `styled-components` team for coming up with a great component API for mixing CSS and JS.
## Usage with Props
```js
import styled from 'styled-elements';
const Header = styled.h2`
color: #${props => props.status === 'success' ? '000' : '333'};
`;
document.body.appendChild(Header({ status: 'success' },
'My Header'
));
```
## With Keyframes
```js
import styled, { keyframes } from 'styled-elements';
const boxmove = keyframes`
0% {top: 0px;}
25% {top: 200px;}
75% {top: 50px}
100% {top: 100px;}
`;
const Box = styled.div`
background-color: lightcoral;
width: 100px;
height: 100px;
display: block;
position :relative;
animation: ${boxmove} 5s infinite;
`;
document.body.appendChild(Box());
```
## Works well with `yo-yo`
```js
import yo from 'yo-yo';
import styled from 'styled-elements';
const Wrapper = styled.div`
padding: 20%;
background: #F1F1F1;
`;
const Header = () => styled(yo`
A Header
`)`
color: #333;
`;
document.body.appendChild(Wrapper(
yo`
${Header()}
console.log('hello!')}>
Some Button
`
));
```
## Distribution
Grab the UMD distributions in the `/dist` folder.
## Contributing
Please help better the ecosystem by submitting issues and pull requests to `styled-elements`. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.
## Guides
You'll find more detailed information on using `styled-elements` and tailoring it to your needs in our guides:
- [User guide](docs/user-guide.md) - Usage, configuration, FAQ and complementary tools.
- [Developer guide](docs/developer-guide.md) - Contributing to `styled-elements` and writing your own code and coverage.
## Help out
There is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:
- Create, enhance, and debug SilentCicero rules (see our guide to ["Working on rules"](./github/CONTRIBUTING.md)).
- Improve documentation.
- Chime in on any open issue or pull request.
- Open new issues about your ideas for making `styled-elements` better, and pull requests to show us how your idea works.
- Add new tests to *absolutely anything*.
- Create or contribute to ecosystem tools, like modules for encoding or contracts.
- Spread the word.
Please consult our [Code of Conduct](CODE_OF_CONDUCT.md) docs before helping out.
We communicate via [issues](https://github.com/SilentCicero/styled-elements/issues) and [pull requests](https://github.com/SilentCicero/styled-elements/pulls).
## Important documents
- [Changelog](CHANGELOG.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [License](https://raw.githubusercontent.com/SilentCicero/styled-elements/master/LICENSE)
## Todo
- Testing
- Coverage
- Documentation
## Licence
This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.md.
```
The MIT License
Copyright (c) 2016 Nick Dodson. nickdodson.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```