toStyle — Style Conversion
17:43Description
$u.toStyle turns a style object or style string into a CSS string that can be bound directly to :style: camelCase keys become kebab-case, multiple arguments are concatenated in order, and the result always ends with a semicolon. The companion $u.splitCssProperty splits text and box properties by a whitelist.
Examples
Passing an object (camelCase to kebab-case)
Object input is emitted as key: value pairs with camelCase keys converted to kebab-case; values are written as-is, so 10 does not become 10px.
View source
<template>
<ux-cell-group :border="false">
<ux-cell-item
v-for="(item, index) in objectList"
:key="index"
:title="item.desc"
:label="item.result"
:arrow="false"
:border-bottom="!item.last"
/>
</ux-cell-group>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
type StyleRow = {
desc: string;
result: string;
last: boolean;
};
// 驼峰属性名会转成 kebab-case,输出串以分号结尾
const objectList: StyleRow[] = [
{ desc: '$u.toStyle({ color: "red" })', result: $u.toStyle({ color: 'red' }), last: false },
{ desc: '$u.toStyle({ fontSize: "10px" })', result: $u.toStyle({ fontSize: '10px' }), last: false },
{ desc: '$u.toStyle({ backgroundColor: "#2979ff" })', result: $u.toStyle({ backgroundColor: '#2979ff' }), last: false },
{ desc: '$u.toStyle({ marginLeft: "5px", marginTop: "10px" })', result: $u.toStyle({ marginLeft: '5px', marginTop: '10px' }), last: true }
];
</script>Passing a string
A style string is kept as-is, with a single trailing semicolon appended.
View source
<template>
<ux-cell-group :border="false">
<ux-cell-item
v-for="(item, index) in stringList"
:key="index"
:title="item.desc"
:label="item.result"
:arrow="false"
:border-bottom="!item.last"
/>
</ux-cell-group>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
type StyleRow = {
desc: string;
result: string;
last: boolean;
};
// 已是样式串时原样保留,仅补结尾分号
const stringList: StyleRow[] = [
{ desc: '$u.toStyle("color: red")', result: $u.toStyle('color: red'), last: false },
{ desc: '$u.toStyle("color: red; font-size: 10px")', result: $u.toStyle('color: red; font-size: 10px'), last: true }
];
</script>Merging objects / passing a string
Multiple arguments are concatenated in order; duplicate properties are neither deduplicated nor overridden, so conflicts must be avoided by the caller.
View source
<template>
<ux-cell-group :border="false">
<ux-cell-item
v-for="(item, index) in mergeList"
:key="index"
:title="item.desc"
:label="item.result"
:arrow="false"
:border-bottom="!item.last"
/>
</ux-cell-group>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
type StyleRow = {
desc: string;
result: string;
last: boolean;
};
// 多参数按顺序拼接,后写者不覆盖前者,需自行保证不冲突
const mergeList: StyleRow[] = [
{ desc: '单对象:多属性拼接', result: $u.toStyle({ color: 'red', fontSize: '10px' }), last: false },
{ desc: '单属性:颜色', result: $u.toStyle({ color: 'blue' }), last: false },
{ desc: '对象 + 样式串:混传入参', result: $u.toStyle({ color: 'blue' }, 'font-size: 12px'), last: true }
];
</script>Split text & box properties
splitCssProperty puts color and font-size into textCssProperty per the built-in text-property whitelist, while background, padding and other keys go into rectCssProperty.
View source
<template>
<ux-cell-group :border="false">
<ux-cell-item title="textCssProperty" :label="splitText" :arrow="false" />
<ux-cell-item title="rectCssProperty" :label="splitRect" :arrow="false" :border-bottom="false" />
</ux-cell-group>
<ux-gap :height="12" />
<view :style="splitRectStyle">
<text :style="splitTextStyle">文本属性挂 text,矩形属性挂 view</text>
</view>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
// 文本属性与矩形属性混在一份样式里
const splitSource = new JsonObject();
splitSource['color'] = '#ff0000';
splitSource['font-size'] = '14px';
splitSource['background-color'] = '#f5f5f5';
splitSource['padding'] = '8px';
// uni-app x 样式不继承:文本属性挂 text,矩形属性挂 view
const splitResult = $u.splitCssProperty(splitSource);
const splitText: string = JSON.stringify(splitResult.textCssProperty);
const splitRect: string = JSON.stringify(splitResult.rectCssProperty);
const splitTextStyle: string = $u.toStyle(splitResult.textCssProperty);
const splitRectStyle: string = $u.toStyle(splitResult.rectCssProperty);
</script>Style preview
The return value of toStyle binds directly to :style; this example renders a live preview block with background, radius and border properties.
View source
<template>
<view class="demo-preview" :style="previewStyle">
<text class="demo-preview-text">样式实时生效</text>
</view>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
// toStyle 的输出可直接绑定到 :style
const previewStyle = $u.toStyle({
backgroundColor: '#ecf5ff',
padding: '10px',
borderRadius: '4px',
borderWidth: '1px',
borderStyle: 'solid',
borderColor: '#2979ff'
});
</script>
<style lang="scss">
.demo-preview {
padding: 10px;
}
.demo-preview-text {
font-size: 14px;
color: $u-main-color;
}
</style>API
toStyle
Parameters:
| Parameter | Description | Type | Default | Version |
|---|---|---|---|---|
| ...styles | Style objects or style strings; multiple arguments are allowed | JsonObject | string | null | - | - |
Returns:
| Type | Description |
|---|---|
string | The concatenated CSS string, each segment ending with ;; returns '' when there is no valid content |
splitCssProperty
Parameters:
| Parameter | Description | Type | Default | Version |
|---|---|---|---|---|
| css | The style object to split | JsonObject | null | - | - |
Returns:
| Type | Description |
|---|---|
SplitCssPropertyResult | Contains textCssProperty and rectCssProperty; a null input returns two empty objects |
Notes
- Object keys are concatenated in
JsonObjectiteration order; uppercase letters in keys are lowercased and prefixed with-, and entries whose value isnullare skipped. - Object values are concatenated as-is with no unit or type conversion, so a number is written as
10rather than10px. - Multiple arguments are never merged or deduplicated; duplicate properties appear repeatedly, so conflicts must be avoided by the caller.
splitCssPropertyonly splits by the built-in text-property whitelist; all other keys go intorectCssProperty.