Vue Styled Components

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

Changelog · English · 中文

[!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

1npm i @vue-styled-components/core

1yarn add @vue-styled-components/core

1pnpm i @vue-styled-components/core

💅Basic

1<script setup lang="ts">
2import { styled } from '@vue-styled-components/core';
3import OtherComponent from './VueComponent.vue';
4
5const StyledDiv = styled('div')`
6  width: 100px;
7  height: 100px;
8  background-color: #ccc;
9  color: #000;
10`;
11const StyledStyledDiv = styled(StyledDiv)`
12  width: 100px;
13  height: 100px;
14  background-color: #000;
15  color: #fff;
16`;
17const StyledOtherComponent = styled(OtherComponent)`
18  width: 100px;
19  height: 100px;
20  background-color: red;
21  color: #fff;
22`;
23</script>
24
25<template>
26  <StyledDiv>Styled Div</StyledDiv>
27  <StyledStyledDiv>Styled Styled Div</StyledStyledDiv>
28  <StyledOtherComponent>Styled Other Vue Component</StyledOtherComponent>
29</template>

🔧Attrs Setting

1<script setup lang="ts">
2import { styled } from '@vue-styled-components/core';
3
4const StyledDiv = styled.div.attrs({
5  class: 'styled-div'
6})`
7  width: 100px;
8  height: 100px;
9  background-color: #ccc;
10  color: #000;
11`;
12</script>
13
14<template>
15  <StyledDiv>Styled Div</StyledDiv>
16  <!-- <div class="styled-div">Styled Div</div> -->
17</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)

1<script setup lang="ts">
2import { styled } from '@vue-styled-components/core';
3
4const StyledDiv = styled('div', {
5  color: String
6})`
7  width: 100px;
8  height: 100px;
9  background-color: #ccc;
10  color: ${(props) => props.color};
11`;
12</script>
13
14<template>
15  <StyledDiv color="red">Styled Div</StyledDiv>
16</template>

🧙Theming

1<script setup lang="ts">
2import { styled, ThemeProvider } from '@vue-styled-components/core';
3
4const StyledDiv = styled.div`
5  width: 100px;
6  height: 100px;
7  background-color: #ccc;
8  color: ${(props) => props.theme.color};
9`;
10</script>
11
12<template>
13  <ThemeProvider :theme="{ color: '#fff' }">
14    <StyledDiv>Styled Div</StyledDiv>
15  </ThemeProvider>
16</template>

More details see docs site

🧑‍🤝‍🧑Contributors

And thanks

• styled-components.
• stylis