---
title: "StyleHelper"

doc_type: static
doc_category: static
doc_version: v20260901
source_url:
  html: 'https://developer.shopline.com/zh-hans-cn/docs/apps/checkout/checkout-ui-customizer/component-utilities/style-helper'
  md: 'https://developer.shopline.com/zh-hans-cn/docs/apps/checkout/checkout-ui-customizer/component-utilities/style-helper.md'
---
# StyleHelper

这是一个用于编写组件属性样式条件值的辅助工具。你可以根据一个或多个条件（例如视口大小）以简洁明了的方式编写复杂的条件样式。

## StyleHelper 方法
| **方法** | | **描述** |
| --- | --- | --- |
| <code data-code-gray>default</code> | <code data-code-gray>\<T\>(defaultValue: T) => [ConditionalStyle](#conditionalstyle)\<T, [Conditions](#conditions)\></code> | 设置默认样式值，当没有其他条件满足时使用。 |
| <code data-code-gray>when</code> | <code data-code-gray>\<T\>(conditions: [Conditions](#conditions), value: T) => [ConditionalStyle](#conditionalstyle)\<T, [Conditions](#conditions)></code> | 为组件样式添加条件规则。所有条件（以对象形式表示）都必须满足，才能应用相应的值。<br/><code data-code-gray>when</code> 方法可以链式调用，以构建更复杂的样式。 |

## 样例
根据当前 [视口断点](#视口断点) 来实现 [View 组件](https://developer.shopline.com/zh-hans-cn/docs/apps/checkout/checkout-ui-customizer/ui-components/structure/view.md) 的分栏效果（当大于 <code data-code-gray>small</code> 时为两行）。

```jsx
<Grid
  rows={['1fr', 'auto']}
  columns={StyleHelper.default(['1fr'])
    .when(
      {
        viewportInlineSize: {
          min: 'extraSmall',
        },
      },
      ['1fr'],
    )
    .when(
      {
        viewportInlineSize: {
          min: 'small',
        },
      },
      ['1fr'],
    )
    .when(
      {
        viewportInlineSize: {
          min: 'medium',
        },
      },
      ['1fr', '1fr'],
    )
    .when(
      {
        viewportInlineSize: {
          min: 'large',
        },
      },
      ['1fr', '1fr'],
    )}
  spacing="loose"
  padding="loose"
>
  <View>View1</View>
  <View>View2</View>
  <View>View3</View>
  <View>View4</View>
</Grid>
```

## 类型说明
### Conditions
条件样式支持以下条件。

可以在同一个<code data-code-gray>when</code>方法上设置多个条件。

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| <code data-code-gray>viewportInlineSize</code> | <code data-code-gray>\{min: "extraSmall" \| "small" \| "medium" \| "large"\}</code> | 配置当前的 [视口断点值](#视口断点)，当设备匹配到对应值时，满足此条件。 |

### ConditionalStyle
| 名称 | 类型 | 描述 |
| --- | --- | --- |
| <code data-code-gray>conditionals</code> | <code data-code-gray>[ConditionalValue](#conditionalvalue)\<T, AcceptedConditions\>[]</code> | 条件值数组。|
| <code data-code-gray>default</code> | <code data-code-gray>T</code> | 当条件中指定的条件值都不满足时应用默认值。|

### ConditionalValue
| 名称 | 类型 | 描述 |
| --- | --- | --- |
| <code data-code-gray>conditions</code> | <code data-code-gray>AcceptedConditions</code> | 应用该值必须满足的条件。必须至少指定一个条件。 |
| <code data-code-gray>value</code> | <code data-code-gray>T</code> | 满足条件时将应用的值。 |

## 视口断点
视口断点是条件判断的其中一个依据，当视口宽度满足如下范围时则会触发对应的值。例如：在视口宽度为 <code data-code-gray>450px</code> 时，StyleHelper 将会识别为 <code data-code-gray>base</code> 断点。

- <code data-code-gray>base</code>：<code data-code-gray>0px</code> ≤ 视口宽度 < <code data-code-gray>580px</code>
- <code data-code-gray>extraSmall</code>：<code data-code-gray>580px</code> ≤ 视口宽度 < <code data-code-gray>750px</code>
- <code data-code-gray>small</code>：<code data-code-gray>750px</code> ≤ 视口宽度 < <code data-code-gray>1000px</code>
- <code data-code-gray>medium</code>：<code data-code-gray>1000px</code> ≤ 视口宽度 < <code data-code-gray>1200px</code>
- <code data-code-gray>large</code>：视口宽度 ≥ <code data-code-gray>1200px</code>
