API

样式参考

本页列出 style 属性可用的每一个键。键名和类型来自生成的声明文件 .nsh/types/nsh/types.d.ts,编辑器会在你输入时检查它们。布局是默认纵向排列的 flexbox,数字的单位是点,同时支持这些 CSS 能力:网格、渐变、盒阴影、滤镜、混合模式、轮廓线、过渡和关键帧动画。

样式怎么写、怎样与 class 组合、文字样式如何继承,见 样式。class 的语法见 Tailwind 参考。

#四个接口

每个接口都扩展前一个:

接口扩展自用于
LayoutStyle所有元素的布局(flexbox、网格、尺寸、间距、定位)
ViewStyleLayoutStyle<View>、<Scroll>、<List>、控件及其他所有元素
TextStyleViewStyle<Text> 和 <Input>(以及视图:视图上的文字样式会传给其中的文字)
ImageStyleViewStyle<Image>
import type { ViewStyle, TextStyle } from "nsh";
import { Text, View } from "nsh";

const card: ViewStyle = {
  padding: 16,
  borderRadius: 12,
  backgroundColor: "#fff",
  boxShadow: "0 4px 12px rgb(0 0 0 / 0.08)",
};

const title: TextStyle = { fontSize: 17, fontWeight: "600", color: "#111" };

<View style={card}>
  <Text style={title}>Hello</Text>
</View>;

style 也接受数组:各项从左到右合并,假值会被跳过,因此条件样式无需展开运算:

<View style={[card, selected() && { borderColor: "#2563eb", borderWidth: 2 }]} />

#值类型

类型接受
number点(与密度无关)。1 在 iOS 上是一个 point,在 Android 上是一个 dp。
DimensionValuenumber(点)、`${number}%`(相对父元素)或 "auto"。
LengthValuenumber(点)或 `${number}%`,不接受 "auto"。
ColorValueCSS 颜色字符串:#rgb、#rgba、#rrggbb、#rrggbbaa、rgb()、rgba()、hsl()、hsla()、oklch()、oklab(),或 CSS 命名颜色(black、white、transparent、rebeccapurple 等)。
NativeNode原生动画值,或由它派生的节点(见 nsh/animated)。backgroundColor、opacity 和 transform 的各步骤接受它,值会在 UI 线程上动画,不经过 JS。

采用 CSS 语法的字符串(boxShadow、backgroundImage、filter、gridTemplateColumns 等)中,长度可写 px 或裸数字(都是点)、pt,或 rem(16 点)。

#LayoutStyle

布局在 Rust 中计算(flexbox 和 CSS 网格)。默认值与 CSS 不同:display: "flex"、flexDirection: "column"、flexShrink: 0、alignContent: "flex-start"、alignItems: "stretch",并且没有自动最小尺寸。见 布局。

#显示与定位

键类型说明
display"flex" | "grid" | "block" | "none"子元素的布局方式。"none" 将元素移出布局并隐藏。"block" 按 CSS 块级布局堆叠子元素。默认 "flex"。
position"relative" | "absolute""absolute" 使元素脱离文档流,按 top / right / bottom / left 相对父元素定位。默认 "relative"。
topDimensionValue距父元素上边(绝对定位),或相对自身位置的偏移(相对定位)。
rightDimensionValue距右边的偏移。从右到左布局中表示结束边。
bottomDimensionValue距下边的偏移。
leftDimensionValue距左边的偏移。从右到左布局中表示起始边。
startDimensionValue从左到右布局中为左,从右到左布局中为右。
endDimensionValue从左到右布局中为右,从右到左布局中为左。
zIndexnumber在兄弟元素间的次序(值相同时保持原顺序),也是原生视图的叠放次序。
direction"inherit" | "ltr" | "rtl"布局方向,默认继承。从右到左时,left 和 right 属性表示起始和结束。

#Flexbox

键类型说明
flexDirection"row" | "column" | "row-reverse" | "column-reverse"主轴方向。默认 "column"。
flexWrap"wrap" | "nowrap" | "wrap-reverse"子元素是否换行。默认 "nowrap"。
flexnumber单个数字,不是 CSS 简写:正数会把 flexGrow 设为该值,同时 flexShrink: 1、flexBasis: 0;0 让元素不伸缩;负数让元素可以收缩到最小尺寸。
flexGrownumber占用剩余空间的比例。默认 0。
flexShrinknumber空间不足时的收缩比例。默认 0,而不是 CSS 的 1。
flexBasisDimensionValue分配剩余空间之前的主轴尺寸。
justifyContent"flex-start" | "flex-end" | "center" | "space-between" | "space-around" | "space-evenly" | "stretch"子元素沿主轴的分布。默认 "flex-start"。
alignItems"flex-start" | "flex-end" | "center" | "stretch" | "baseline"子元素在交叉轴上的对齐。默认 "stretch"。
alignSelf"auto" | "flex-start" | "flex-end" | "center" | "stretch" | "baseline"为当前元素覆盖父元素的 alignItems。
alignContent"flex-start" | "flex-end" | "center" | "stretch" | "space-between" | "space-around" | "space-evenly"多行(及网格轨道)在交叉轴上的分布。默认 "flex-start"。
gapLengthValue子元素行与列之间的间距。
rowGapLengthValue行间距。
columnGapLengthValue列间距。

#网格

设置 display: "grid" 后,子元素按 CSS 网格排列。轨道列表使用 CSS 语法。

键类型说明
gridTemplateColumnsstring列轨道:"repeat(3, 1fr)"、"200px 1fr"、minmax()、auto-fill / auto-fit、网格线名称。
gridTemplateRowsstring行轨道,语法同上。
gridAutoColumnsstring隐式创建的列的尺寸。
gridAutoRowsstring隐式创建的行的尺寸。
gridAutoFlow"row" | "column" | "dense" | "row dense" | "column dense"未指定位置的项目如何填入网格。
gridColumnnumber | string列位置:"1 / 3"、"span 2"、网格线编号或名称。
gridColumnStartnumber | string起始列线。
gridColumnEndnumber | string结束列线。
gridRownumber | string行位置,语法同 gridColumn。
gridRowStartnumber | string起始行线。
gridRowEndnumber | string结束行线。
justifyItems"flex-start" | "flex-end" | "center" | "stretch" | "baseline"网格项在其区域内沿行方向的位置。
justifySelf"auto" | "flex-start" | "flex-end" | "center" | "stretch" | "baseline"为当前项覆盖 justifyItems。
<View style={{ display: "grid", gridTemplateColumns: "repeat(3, 1fr)", gap: 8 }}>
  <View style={{ gridColumn: "span 2", height: 60, backgroundColor: "#c7d2fe" }} />
  <View style={{ height: 60, backgroundColor: "#a5b4fc" }} />
</View>

#尺寸

键类型说明
widthDimensionValue宽度。
heightDimensionValue高度。
minWidthLengthValue最小宽度。
minHeightLengthValue最小高度。
maxWidthLengthValue最大宽度。
maxHeightLengthValue最大高度。
aspectRationumber宽高比(宽 ÷ 高),缺少的一边由另一边算出。

#外边距

外边距接受 "auto"(与 flexbox 中一样吸收剩余空间)和负值。

键类型说明
marginDimensionValue四边。
marginHorizontalDimensionValue左右。
marginVerticalDimensionValue上下。
marginTopDimensionValue上。
marginRightDimensionValue右。
marginBottomDimensionValue下。
marginLeftDimensionValue左。
marginStartDimensionValue从左到右布局中为左,从右到左布局中为右。
marginEndDimensionValue与 marginStart 相对的一边。

#内边距

键类型说明
paddingLengthValue四边。
paddingHorizontalLengthValue左右。
paddingVerticalLengthValue上下。
paddingTopLengthValue上。
paddingRightLengthValue右。
paddingBottomLengthValue下。
paddingLeftLengthValue左。
paddingStartLengthValue从左到右布局中为左,从右到左布局中为右。
paddingEndLengthValue与 paddingStart 相对的一边。

#ViewStyle

视图绘制的一切。LayoutStyle 的全部键同样适用。

#背景

键类型说明
backgroundColorColorValue | NativeNode填充色。接受原生动画颜色。
backgroundImagestring画在背景色之上的 CSS 渐变:linear-gradient(...)、radial-gradient(...)、conic-gradient(...),多个用逗号分隔。
experimental_backgroundImagestringbackgroundImage 的别名。
<View style={{ height: 120, borderRadius: 16, backgroundImage: "linear-gradient(135deg, #6366f1, #ec4899)" }} />

#边框

键类型说明
borderWidthnumber四边宽度。
borderTopWidthnumber上边。
borderRightWidthnumber右边。
borderBottomWidthnumber下边。
borderLeftWidthnumber左边。
borderStartWidthnumber起始边(从左到右布局中为左)。
borderEndWidthnumber结束边。
borderColorColorValue四边颜色。
borderTopColorColorValue上边。
borderRightColorColorValue右边。
borderBottomColorColorValue下边。
borderLeftColorColorValue左边。
borderStartColorColorValue起始边。
borderEndColorColorValue结束边。
borderStyle"solid" | "dashed" | "dotted"线型。默认 "solid"。

#圆角

键类型说明
borderRadiusnumber四个角的半径。
borderTopLeftRadiusnumber左上角。
borderTopRightRadiusnumber右上角。
borderBottomRightRadiusnumber右下角。
borderBottomLeftRadiusnumber左下角。
borderTopStartRadiusnumber起始侧的上角。
borderTopEndRadiusnumber结束侧的上角。
borderBottomStartRadiusnumber起始侧的下角。
borderBottomEndRadiusnumber结束侧的下角。
borderCurve"circular" | "continuous""continuous":曲率平滑过渡到直边的圆角,类似 iOS 应用图标。盒子太小时退回普通圆角,所以胶囊形依然是胶囊形。两个平台都支持。

#轮廓线

轮廓线画在边框之外,不占布局空间。

键类型说明
outlineWidthnumber线宽。
outlineColorColorValue颜色。
outlineStyle"solid" | "double" | "dashed" | "dotted" | "none" | "hidden"线型。
outlineOffsetnumber与边框外缘的距离;负值向内。

#阴影

两种方式投射阴影:CSS 的 boxShadow(多层、扩展、内阴影),或四个 shadow* 键。

键类型说明
boxShadowstringCSS box-shadow:偏移、模糊、扩展和颜色,多层用逗号分隔,inset 表示内阴影。
shadowColorColorValue阴影颜色。
shadowOffset{ width: number; height: number }偏移。默认 { width: 0, height: -3 }。
shadowOpacitynumber不透明度,0 到 1。默认 0(无阴影)。
shadowRadiusnumber模糊半径。默认 3。
<View style={{ padding: 16, borderRadius: 12, backgroundColor: "#fff",
  boxShadow: "0 1px 2px rgb(0 0 0 / 0.06), 0 8px 24px -4px rgb(0 0 0 / 0.12)" }} />

#不透明度、可见性与裁剪

键类型说明
opacitynumber | NativeNode0(不可见)到 1。接受原生动画值。
visibility"visible" | "hidden" | "collapse"隐藏的视图仍占据布局空间(与 display: "none" 不同)。
overflow"visible" | "hidden""hidden" 将子元素裁剪到视图边界(含圆角)。
backfaceVisibility"visible" | "hidden""hidden":3D 旋转转到背面时不可见。

#变换

键类型说明
transformTransformStep[]步骤列表,与 CSS 一样从右向左应用。
transformOriginstring | (number | string)[]transform 的作用中心:关键字、百分比和长度("top left"、"50% 0"、[10, 20])。默认为中心。

TransformStep 是只有一个键的对象:

步骤值原生动画
translateX、translateYnumber(点)支持
scale、scaleX、scaleYnumber(倍数)支持
rotate、rotateZ、rotateX、rotateYnumber(度)或 string("45deg"、"0.5rad")支持
skewX、skewYnumber(度)或 string不支持
perspectivenumber不支持
<View style={{ transform: [{ perspective: 600 }, { rotateY: "20deg" }, { scale: 0.95 }] }} />

#滤镜与混合

键类型说明
filterstring作用于视图及其内容的 CSS 滤镜:brightness()、contrast()、grayscale()、hue-rotate()、invert()、saturate()、sepia()、opacity()、blur()、drop-shadow()。
backdropFilterstring作用于视图背后内容的 CSS 滤镜,例如毛玻璃效果 "blur(10px)"。
mixBlendMode"normal" | "multiply" | "screen" | "overlay" | "darken" | "lighten" | "color-dodge" | "color-burn" | "hard-light" | "soft-light" | "difference" | "exclusion" | "hue" | "saturation" | "color" | "luminosity" | "plus-darker" | "plus-lighter"视图与背后内容的混合方式。

#过渡

当参与过渡的属性改变时(来自新样式、class,或 active: 等变体),平台以原生方式执行动画,期间不运行任何 JS。

键类型说明
transitionPropertystring参与动画的属性,用逗号分隔:"all"、"colors"(color、backgroundColor、borderColor 等)、"opacity"、"transform"、"boxShadow"、"borderRadius"、"borderWidth",或 "none"。
transitionDurationnumber | "${number}ms" | "${number}s"数字表示毫秒,也可写 "150ms" / "0.2s"。
transitionDelaynumber | "${number}ms" | "${number}s"过渡开始前的延迟。
transitionTimingFunction"linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | "cubic-bezier(...)"缓动曲线。
<View
  onPress={() => open.set(!open())}
  style={{ height: open() ? 160 : 56, opacity: open() ? 1 : 0.8,
    transitionProperty: "opacity, transform", transitionDuration: 200 }}
/>

#关键帧动画

内置的关键帧动画,以原生方式运行(对应 Tailwind 的 animate-*)。

键类型说明
animationName"none" | "spin" | "ping" | "pulse" | "bounce"动画名称。
animationDurationnumber | "${number}ms" | "${number}s"单次时长。
animationDelaynumber | "${number}ms" | "${number}s"首次开始前的延迟。
animationTimingFunction"linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | "cubic-bezier(...)"缓动曲线。
animationIterationCountnumber | "infinite"重复次数。

由数值、手势或弹簧驱动的动画请使用 nsh/animated。

#指针

键类型说明
cursor"auto" | "default" | "pointer" | "text" | "grab" | "grabbing" | "not-allowed" | ...(所有 CSS 光标关键字及 "none")指针悬停在视图上时的形状,适用于指针设备(iPad 触控板、Mac Catalyst、桌面)。

#TextStyle

文字样式用于 <Text> 和 <Input>。它们也像 CSS 一样会继承:视图上设置的文字属性会传给其中的文字和输入框,嵌套的 <Text> 片段继承父文字的样式。ViewStyle 的全部键同样适用。见 文字。

#字体

键类型说明
colorColorValue文字颜色。
fontSizenumber字号,单位为点。
fontWeight"normal" | "bold" | number | "${number}""normal"(400)、"bold"(700)或 100–900。
fontFamilystring系统字体族,或导入字体得到的名字(import Inter from "./Inter.ttf")。见 字体。
fontStyle"normal" | "italic"斜体。
fontVariant("small-caps" | "oldstyle-nums" | "lining-nums" | "tabular-nums" | "proportional-nums")[]OpenType 数字与字母形式。tabular-nums 让数字等宽,适合计数器和计时器。

#间距与对齐

键类型说明
lineHeightnumber行高,单位为点。
letterSpacingnumber字符间的额外间距,单位为点。
textAlign"auto" | "left" | "center" | "right" | "justify"水平对齐。
textAlignVertical"auto" | "top" | "center" | "bottom"文字比盒子矮时的位置(设置了高度的 <Text>)。
writingDirection"auto" | "ltr" | "rtl"文字的基础方向;"auto" 由内容决定。
textTransform"none" | "uppercase" | "lowercase" | "capitalize"大小写转换。

#装饰线

键类型说明
textDecorationLine"none" | "underline" | "line-through" | "underline line-through"与文字一起绘制的线。
textDecorationColorColorValue线的颜色(默认为文字颜色)。
textDecorationStyle"solid" | "double" | "dotted" | "dashed" | "wavy"线型。
textDecorationThicknessnumber | "auto" | "from-font"线的粗细。
textUnderlineOffsetnumber | "auto"下划线与基线的距离。

#文字阴影

键类型说明
textShadowColorColorValue阴影颜色。
textShadowOffset{ width: number; height: number }阴影偏移。
textShadowRadiusnumber模糊半径。

#ImageStyle

包含 ViewStyle 的全部键,另加:

键类型说明
tintColorColorValue为模板图片重新着色(所有不透明像素都变成这个颜色),用于单色图标。

图片如何填充盒子由 <Image> 的 resizeMode 属性决定,不是样式;见 image。

#看起来像样式的属性

有些设置在 nsh 中是属性而不是样式键。它们有对应的 Tailwind class,但显式设置的属性优先于 class:

设置属性Class
行数限制<Text> 的 numberOfLinesline-clamp-*、truncate
省略位置<Text> 的 ellipsizeModetext-ellipsis、text-clip
触摸穿透pointerEventspointer-events-none、pointer-events-auto
图片填充<Image> 的 resizeModeobject-cover、object-contain 等
文字可选<Text> 的 selectableselect-text、select-none
占位符颜色<Input> 的 placeholderTextColorplaceholder:text-*
Material 阴影(Android)android={{ elevation }}

#相关

  • 样式:style、class、继承与优先级。
  • Tailwind 参考:支持的全部工具类和变体。
  • 布局:flexbox 和网格的实际用法。
  • view、text、image:这些样式所作用的元素。