Vue Styled Components

A CSS tool similar to styled-components and support for vue 3. Help you to develop your apps fastly!

[![CI status][github-action-image]][github-action-url] [![NPM version][npm-version]][npm-url] [![minified size][npm-bundle-size]][npm-url] [![Coverage Status][coverage]][codecov-url] [![chat on discord][discord]][discord-url] [github-action-image]: https://github.com/vue-styled-components/core/workflows/Code%20Check/badge.svg [github-action-url]: https://github.com/vue-styled-components/core/actions/workflows/code-check.yml [npm-version]: https://img.shields.io/npm/v/%40vue-styled-components%2Fcore [npm-bundle-size]: https://img.shields.io/bundlejs/size/%40vue-styled-components%2Fcore [npm-url]: http://npmjs.org/package/@vue-styled-components/core [coverage]: https://coveralls.io/repos/github/vue-styled-components/core/badge.svg?branch=main [codecov-url]: https://coveralls.io/github/vue-styled-components/core?branch=main [discord]: https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true [discord-url]: https://discord.gg/UbJxnvt2UH [Changelog](./CHANGELOG.md) · English · [中文](./README.zh_CN.md)

[!IMPORTANT] The package has been moved to new npm org @vue-styled-components/core and the old org has been deprecated. Please use the new package instead.

✨Feature

✅ Style vue component or styled component

✅ Set default attrs

✅ Passed props

✅ Support theming

✅ Generate keyframes

✅ Generate css mixin

✅ Create global style

✅ Add or override attrs

✅ Support nesting css.

✅ Auto-prefix css.

...

📖Documentation

For detailed introduction and usage instructions, please refer to the documentation website

🚀Getting Start

📦Install

npm i @vue-styled-components/core

yarn add @vue-styled-components/core

pnpm i @vue-styled-components/core

💅Basic

<script setup lang="ts">
import { styled } from '@vue-styled-components/core';
import OtherComponent from './VueComponent.vue';

const StyledDiv = styled('div')`
  width: 100px;
  height: 100px;
  background-color: #ccc;
  color: #000;
`;
const StyledStyledDiv = styled(StyledDiv)`
  width: 100px;
  height: 100px;
  background-color: #000;
  color: #fff;
`;
const StyledOtherComponent = styled(OtherComponent)`
  width: 100px;
  height: 100px;
  background-color: red;
  color: #fff;
`;
</script>

<template>
  <StyledDiv>Styled Div</StyledDiv>
  <StyledStyledDiv>Styled Styled Div</StyledStyledDiv>
  <StyledOtherComponent>Styled Other Vue Component</StyledOtherComponent>
</template>

🔧Attrs Setting

<script setup lang="ts">
import { styled } from '@vue-styled-components/core';

const StyledDiv = styled.div.attrs({
  class: 'styled-div'
})`
  width: 100px;
  height: 100px;
  background-color: #ccc;
  color: #000;
`;
</script>

<template>
  <StyledDiv>Styled Div</StyledDiv>
  <!-- <div class="styled-div">Styled Div</div> -->
</template>

🕹️Control Dynamic Style by Props

You must define the props in the styled function if you want to use them in the style. Because Vue components require explicit props declaration so that Vue knows what external props passed to the component should be treated as fallthrough attributes.(see Props Declaration)

<script setup lang="ts">
import { styled } from '@vue-styled-components/core';

const StyledDiv = styled('div', {
  color: String
})`
  width: 100px;
  height: 100px;
  background-color: #ccc;
  color: ${(props) => props.color};
`;
</script>

<template>
  <StyledDiv color="red">Styled Div</StyledDiv>
</template>

🧙Theming

<script setup lang="ts">
import { styled, ThemeProvider } from '@vue-styled-components/core';

const StyledDiv = styled.div`
  width: 100px;
  height: 100px;
  background-color: #ccc;
  color: ${(props) => props.theme.color};
`;
</script>

<template>
  <ThemeProvider :theme="{ color: '#fff' }">
    <StyledDiv>Styled Div</StyledDiv>
  </ThemeProvider>
</template>

More details see docs site

🧑‍🤝‍🧑Contributors

And thanks