文件
版面配置
NSH 以 Taffy 排版每個元素。Taffy 是以 Rust 實作的 CSS flexbox、grid 與 block 版面配置,預設設定為子元素垂直堆疊且不縮小。版面配置在核心中執行,發生於你的程式碼每次執行回合之後,且只有變動的 frame 會送往原生 view。文字由平台的文字引擎在同一個執行緒上測量,因此版面配置從不等待主執行緒。
import { mount, Scroll, signal, Text, View } from "nsh";
import { button, buttonText, desktop, Inspector, tint, ui, wide } from "./palette";
type Direction = "column" | "row";
type Justify = "flex-start" | "center" | "flex-end" | "space-between" | "space-evenly";
type Align = "stretch" | "flex-start" | "center" | "flex-end";
function Choice<T extends string>(props: { label: string; options: readonly T[]; value: T; onChange: (v: T) => void }) {
return (
<View style={{ gap: 4 }}>
<Text style={{ fontSize: 12, fontWeight: "600", color: ui().muted }}>{props.label}</Text>
<View style={{ flexDirection: "row", flexWrap: "wrap", gap: 6 }}>
<Each of={props.options}>
{(o) => (
<View onPress={() => props.onChange(o())} {...button("secondary", { size: "sm", on: () => props.value === o() })}>
<Text style={buttonText("secondary", { on: () => props.value === o() })}>{o()}</Text>
</View>
)}
</Each>
</View>
</View>
);
}
function App() {
const direction = signal<Direction>("row");
const justify = signal<Justify>("flex-start");
const align = signal<Align>("stretch");
const colors = () => [ui().down, ui().info, ui().up];
const box = (height: number) => (
<View
style={{
height,
padding: 10,
gap: 8,
borderRadius: 12,
...ui().inset,
flexDirection: direction(),
justifyContent: justify(),
alignItems: align(),
}}
>
<Each of={colors()}>
{(c, i) => (
<View style={{ minWidth: 44, minHeight: 44, padding: 6, borderRadius: 8, backgroundColor: c() }}>
<Text style={{ color: ui().page, fontWeight: "700" }}>{i() + 1}</Text>
</View>
)}
</Each>
</View>
);
const more = () => (
<>
<Text style={{ fontSize: 12, fontWeight: "600", color: ui().muted }}>flex: 1 / 2 / fixed, percentages, aspectRatio</Text>
<View style={{ flexDirection: "row", gap: 8 }}>
<View style={{ flex: 1, height: 36, borderRadius: 6, backgroundColor: tint(ui().info, 0.3) }} />
<View style={{ flex: 2, height: 36, borderRadius: 6, backgroundColor: tint(ui().info, 0.6) }} />
<View style={{ width: 36, height: 36, borderRadius: 6, backgroundColor: ui().info }} />
</View>
<View style={{ flexDirection: "row", gap: 8, alignItems: "flex-start" }}>
<View style={{ width: "30%", aspectRatio: 1, borderRadius: 8, backgroundColor: tint(ui().warn, 0.35) }} />
<View style={{ width: "40%", aspectRatio: 16 / 9, borderRadius: 8, backgroundColor: ui().warn }} />
</View>
<Text style={{ fontSize: 12, fontWeight: "600", color: ui().muted }}>grid</Text>
<View style={{ display: "grid", gridTemplateColumns: "repeat(4, 1fr)", gap: 6 }}>
<View style={{ gridColumn: "span 2", height: 40, borderRadius: 6, backgroundColor: tint(ui().violet, 0.3) }} />
<View style={{ height: 40, borderRadius: 6, backgroundColor: tint(ui().violet, 0.6) }} />
<View style={{ gridRow: "span 2", borderRadius: 6, backgroundColor: ui().violet }} />
<View style={{ gridColumn: "1 / 4", height: 40, borderRadius: 6, backgroundColor: tint(ui().violet, 0.8) }} />
</View>
<Text style={{ fontSize: 12, fontWeight: "600", color: ui().muted }}>position: absolute</Text>
<View style={{ ...ui().inset, height: 100, borderRadius: 12 }}>
<View style={{ position: "absolute", top: 8, left: 8, width: 60, height: 40, borderRadius: 6, backgroundColor: ui().up }} />
<View style={{ position: "absolute", right: 8, bottom: 8, width: "40%", height: 30, borderRadius: 6, backgroundColor: ui().down }} />
<View style={{ position: "absolute", top: 0, bottom: 0, left: "50%", width: 2, backgroundColor: ui().border }} />
</View>
</>
);
const justifyChoice = () => (
<Choice
label="justifyContent"
options={["flex-start", "center", "flex-end", "space-between", "space-evenly"] as const}
value={justify()}
onChange={(v) => justify.set(v)}
/>
);
const alignChoice = () => (
<Choice label="alignItems" options={["stretch", "flex-start", "center", "flex-end"] as const} value={align()} onChange={(v) => align.set(v)} />
);
return (
<>
{() =>
wide() ? (
<View style={{ flex: 1, backgroundColor: ui().page, flexDirection: "row", padding: 20, paddingTop: 24, gap: 16 }}>
<Scroll style={{ flex: 1, minWidth: 0 }}>
<View style={{ gap: 14 }}>
{box(260)}
{more()}
</View>
</Scroll>
<Inspector>
<Choice label="flexDirection" options={["row", "column"] as const} value={direction()} onChange={(v) => direction.set(v)} />
{justifyChoice()}
{alignChoice()}
</Inspector>
</View>
) : (
<Scroll style={{ flex: 1, backgroundColor: ui().page }}>
<View style={{ padding: 20, paddingTop: 24, gap: 14 }}>
<View
onPress={() => direction.set(direction() === "row" ? "column" : "row")}
{...button("primary", { align: "flex-start" })}
>
<Text style={buttonText("primary")}>
flexDirection: {direction()} ({desktop ? "click" : "tap"} to switch)
</Text>
</View>
{justifyChoice()}
{alignChoice()}
{box(220)}
{more()}
</View>
</Scroll>
)
}
</>
);
}
mount(App);以下的版面配置屬性都是樣式屬性。在 Rust 中是具型別的樣式方法(.flex_row()、.gap_4()、.grid_cols(3)、.absolute().inset_0());在 TSX 中是 style prop 的鍵,且各有對應的 Tailwind class(flex-row、gap-4、grid-cols-3、absolute inset-0 等)。兩者最終都會轉換為相同的原生樣式。
#Flexbox
view 以 flexbox 排版其子元素。未設定 display 的 view 會將子元素排成一欄;樣式中的 display: "flex" 會排成一列,除非設定了 flexDirection,這與 CSS 以及 Tailwind 的 flex class 完全相同。在沒有任何設定的情況下,會套用下列預設值:
| 屬性 | NSH 預設值 | 網頁預設值 |
|---|---|---|
flexDirection | "column"(未設定 display 的 view);設定 display: "flex" 後為 "row" | row |
flexShrink | 0 | 1 |
alignContent | "flex-start"(grid:"normal") | normal |
alignItems | "stretch" | stretch |
minWidth / minHeight | 0 | auto |
position | "relative" | static |
view()
.flex_row()
.items_center()
.gap_3()
.p_4()
.child(image(avatar).size(px(40.0)).rounded(px(20.0)))
.child(
view()
.flex_1()
.gap_0p5()
.child(text(name).font_weight(FontWeight::SEMIBOLD))
.child(text(message).text_color(rgb(0x6e7781)).number_of_lines(1)),
)
.child(text(time).text_color(rgb(0x6e7781)))<View style={{ flexDirection: "row", alignItems: "center", gap: 12, padding: 16 }}>
<Image src={avatar} style={{ width: 40, height: 40, borderRadius: 20 }} />
<View style={{ flex: 1, gap: 2 }}>
<Text style={{ fontWeight: "600" }}>{props.name}</Text>
<Text style={{ numberOfLines: 1, color: "#6e7781" }}>{props.message}</Text>
</View>
<Text style={{ color: "#6e7781" }}>{props.time}</Text>
</View>| 屬性 | 值 | Rust |
|---|---|---|
flexDirection | "column"、"row"、"column-reverse"、"row-reverse" | .flex_col()、.flex_row()、.flex_col_reverse()、.flex_row_reverse() |
justifyContent | 主軸:"flex-start"、"flex-end"、"start"、"end"、"center"、"space-between"、"space-around"、"space-evenly"、"stretch" | .justify_start()、.justify_center()、.justify_end()、.justify_between()、.justify_around()、.justify_evenly() |
alignItems | 交叉軸:"stretch"、"flex-start"、"flex-end"、"start"、"end"、"self-start"、"self-end"、"center"、"baseline" | .items_stretch()、.items_start()、.items_center()、.items_end()、.items_baseline() |
alignSelf | 單一子元素的交叉軸對齊;"auto" 沿用父元素的 alignItems | .self_start()、.self_center()、.self_end()、.self_stretch() |
alignContent | 換行容器中各行的對齊 | |
flexWrap | "nowrap"、"wrap"、"wrap-reverse" | .flex_wrap() |
flex | 單一數字的簡寫(見下) | .flex_1()、.flex_auto()、.flex_none() |
flexGrow、flexShrink、flexBasis | 與 CSS 相同 | .flex_grow(n)、.flex_shrink(n)、.flex_shrink_0()、.basis(length) |
gap、rowGap、columnGap | 子元素之間的間距 | .gap(length)、.gap_y(length)、.gap_x(length),以及各階層 .gap_2()、.gap_x_4() 等 |
flex-start 與 flex-end 依循 flex 方向;start 與 end 依循書寫方向,與 CSS 相同(由右至左時,start 是右側),而 self-start / self-end 則是子元素自身的設定。
flex 是 CSS 的簡寫,Tailwind 的 flex-* class 亦然:數字 n 表示以 n 放大、以 1 縮小,並從 0 的 basis 開始,因此無論內容為何,flex: 1 的同層元素(Rust 中為 .flex_1(),flex-1)都會平均分配空間;"none" 即 0 0 auto(view 保持其大小),"auto" 即 1 1 auto,"initial" 即 0 1 auto,grow、shrink 與 basis 也可以分開寫出("2 0 50%"、"1 1 120px")。由於最小尺寸預設為 0,flex: 0(0 1 0)會把 view 縮到什麼都不剩,除非以 minWidth: "auto" 保留其內容的大小。
view()
.flex_row()
.gap_2()
// One share.
.child(view().flex_1().h(px(36.0)).bg(rgb(0xc8e1ff)))
// Two shares.
.child(view().flex_grow(2.0).flex_shrink(1.0).basis(px(0.0)).h(px(36.0)).bg(rgb(0x79b8ff)))
// Fixed.
.child(view().size(px(36.0)).bg(rgb(0x0366d6)))<View style={{ flexDirection: "row", gap: 8 }}>
<View style={{ flex: 1, height: 36, backgroundColor: "#c8e1ff" }} /> {/* one share */}
<View style={{ flex: 2, height: 36, backgroundColor: "#79b8ff" }} /> {/* two shares */}
<View style={{ width: 36, height: 36, backgroundColor: "#0366d6" }} /> {/* fixed */}
</View>因為最小尺寸預設為 0,位於列中的 flex: 1 文字會縮小並換行,而不是把同層元素擠出去。minWidth: "auto" / minHeight: "auto"(Rust 中為 min-w-auto / min-h-auto、.min_w(auto()))則是 CSS 的自動最小值:縮小中的元素會停在其內容的最小尺寸,也就是文字中最長的單字,與網頁相同。
#尺寸
| 屬性 | 值 | Rust |
|---|---|---|
width、height | 點數、相對於父元素的百分比("50%"),或 "auto" | .w(px(120.0))、.h(relative(0.5))、.w_full()、.size(px(44.0)),以及各階層 .w_10() 等 |
minWidth、maxWidth、minHeight、maxHeight | 點數或百分比;minWidth / minHeight 也可用 "auto",即內容的最小尺寸 | .min_w(..)、.max_w(..)、.min_h(..)、.max_h(..) |
aspectRatio | 寬度除以高度:1、16 / 9 | .aspect_ratio(16.0 / 9.0)、.aspect_square() |
padding、paddingHorizontal、paddingVertical、paddingTop 等 | 點數或百分比 | .p(..)、.px(..)、.py(..)、.pt(..) 等,以及各階層 .p_4()、.px_2() 等 |
margin、marginHorizontal、marginVertical、marginTop 等 | 點數、百分比或 "auto" | .m(..)、.mx(..)、.my(..)、.mt(..) 等、.mx(auto()) |
在 Rust 中,長度是具型別的:px(16.0) 是 16 點,relative(0.5) 是父元素的 50%,auto() 是 auto。階層方法遵循 Tailwind 的間距刻度,每階 4 點(.p_4() 是 16 點,.gap_0p5() 是 2 點)。
未指定尺寸時,view 的大小等於其內容(加上 padding),並由預設的 alignItems: "stretch" 沿父元素的交叉軸拉伸。百分比相對於父元素的尺寸(padding 與 margin 的百分比與 CSS 相同,是相對於其寬度)。
aspectRatio 會根據已知的那個維度推算另一個維度的大小:
view().w_full().aspect_ratio(16.0 / 9.0).bg(black())<View style={{ width: "100%", aspectRatio: 16 / 9, backgroundColor: "#000000" }} />app 資源中的圖片具有自然尺寸,未指定尺寸時會以該尺寸排版(圖片與資源)。遠端圖片在載入完成前沒有尺寸:請為它們指定尺寸。
#Grid
display: "grid"(Rust 中為 .grid())以 CSS grid 的軌道排版子元素:
view()
.grid()
.grid_template_columns("repeat(3, 1fr)")
.gap_2()
.child(view().col_span(2).h(px(60.0)).bg(rgb(0xd8b9ff)))
.child(view().h(px(60.0)).bg(rgb(0xb083f0)))
.child(view().row_span(2).bg(rgb(0x8250df)))
.child(view().col_start(2).col_end(4).h(px(60.0)).bg(rgb(0x6639ba)))<View style={{ display: "grid", gridTemplateColumns: "repeat(3, 1fr)", gap: 8 }}>
<View style={{ gridColumn: "span 2", height: 60, backgroundColor: "#d8b9ff" }} />
<View style={{ height: 60, backgroundColor: "#b083f0" }} />
<View style={{ gridRow: "span 2", backgroundColor: "#8250df" }} />
<View style={{ gridColumn: "2 / 4", height: 60, backgroundColor: "#6639ba" }} />
</View>| 屬性 | 值 | Rust |
|---|---|---|
gridTemplateColumns、gridTemplateRows | CSS 軌道清單:"repeat(3, 1fr)"、"200px 1fr"、minmax()、auto-fill / auto-fit、線名稱 | .grid_cols(3)、.grid_rows(2)、.grid_template_columns("200px 1fr")、.grid_template_rows(..) |
gridAutoColumns、gridAutoRows | 隱式建立的欄與列的軌道 | |
gridAutoFlow | "row"、"column"、"dense"、"row dense"、"column dense" | .grid_flow_col()、.grid_flow_dense() |
gridColumn、gridRow | "1 / 3"、"span 2"、線編號或名稱:"content-start / content-end"、"2 col"(名為 col 的第二條線)、"span col"(直到下一條名為 col 的線) | .col_span(2)、.row_span(2)、.col_span_full() |
gridColumnStart、gridColumnEnd、gridRowStart、gridRowEnd | 線編號或名稱 | .col_start(1)、.col_end(3)、.row_start(..)、.row_end(..)(線編號) |
justifyItems、justifySelf | 項目沿列方向在其區域中的位置:"start"、"end"、"center"、"stretch" 等 | |
alignItems、alignSelf | 項目沿欄方向在其區域中的位置 | .items_*()、.self_*() |
justifyContent、alignContent | 軌道沿列與欄方向在 grid 中的位置 | .justify_*() |
模板以方括號為各條線命名,每條線可有一個或多個名稱,項目則依這些名稱放置,與 CSS 相同(在 Rust 中則依線的編號):
view()
.grid()
.grid_template_columns("[full-start] 16px [content-start] 1fr [content-end] 16px [full-end]")
// content-start / content-end: lines 2 to 3.
.child(view().col_start(2).col_end(3).h(px(60.0)).bg(rgb(0xb083f0)))
// full-start / full-end: lines 1 to 4.
.child(view().col_start(1).col_end(4).h(px(60.0)).bg(rgb(0x8250df)))<View style={{ display: "grid", gridTemplateColumns: "[full-start] 16px [content-start] 1fr [content-end] 16px [full-end]" }}>
<View style={{ gridColumn: "content-start / content-end", height: 60, backgroundColor: "#b083f0" }} />
<View style={{ gridColumn: "full-start / full-end", height: 60, backgroundColor: "#8250df" }} />
</View>在 grid 中,justifyContent 與 alignContent 預設為 CSS 的 "normal":尺寸為 auto 的軌道會拉伸以填滿容器,因此有高度但沒有列模板的 grid,會把該高度分配給它的各列。明確設定的值("start"、"center"、"space-between" 等)會如同在 CSS 中一樣放置軌道。對齊 class 設定的內容與 Tailwind CSS 完全一致:content-start(align-content: flex-start)與 place-content-start 將軌道集中在起點,而 content-normal 與 justify-normal 則將軌道拉伸,與瀏覽器相同。
display: "block" 使用 CSS block 版面配置(子元素依序堆疊,各自與容器同寬),而 display: "none"(.hidden())則將 view 從版面配置中移除。
#絕對定位
position: "absolute"(.absolute())會讓 view 脫離正常排版流程,並依 top、right、bottom 與 left 相對於其父元素定位:
view()
.h(px(200.0))
.child(image(cover).absolute().inset_0())
.child(
view()
.absolute()
.left_3()
.right_3()
.bottom_3()
.child(text("Caption").text_color(white()).font_weight(FontWeight::BOLD)),
)<View style={{ height: 200 }}>
<Image src={cover} style={{ position: "absolute", top: 0, right: 0, bottom: 0, left: 0 }} />
<View style={{ position: "absolute", left: 12, right: 12, bottom: 12 }}>
<Text style={{ color: "#ffffff", fontWeight: "700" }}>Caption</Text>
</View>
</View>偏移量接受點數與百分比(Rust 中為 .top(..)、.right(..)、.bottom(..)、.left(..)、.inset(..))。同時設定 left 與 right(或 top 與 bottom)且未指定尺寸的 view,會在兩者之間拉伸。較後面的同層元素會繪製在較前面的之上;zIndex(.z_index(n))可改變此順序。
#量測
onLayout(.on_layout(..))會在 view 的 frame 發生變動的每次版面配置之後,回報其相對於父元素的 frame:
let width = signal(0.0_f32);
view()
.on_layout(move |frame: &Bounds<Points>| width.set(frame.size.width.0))
.child(text(move || format!("{} points wide", width.get())))const width = signal(0);
<View onLayout={({ bounds }) => width.set(bounds.size.width)}>
<Text>{width()} points wide</Text>
</View>frame 以點為單位:Rust 中為 Bounds<Points>,TSX 中為 { bounds },即 Bounds({ origin: { x, y }, size: { width, height } })。若要取得整個視窗的資訊,請在 Rust 中讀取 window(),或在 TSX 中從 nsh 讀取 windowSize();兩者都會隨旋轉與視窗大小調整而更新,讀取它們的樣式也會隨視窗而變:
view().style_when(|| window().width > px(600.0), |s| s.flex_row())import { View } from "nsh";
import { windowSize } from "nsh";
<View style={{ flexDirection: windowSize().width > 600 ? "row" : "column" }} />Tailwind 的斷點(sm:、md: 等)以及 portrait: / landscape: 不需撰寫程式碼就能得到相同的結果。
#安全區域
根 view 涵蓋整個螢幕,位於狀態列與 Home 指示器之下。請以 CSS 的 env()(paddingTop: "env(safe-area-inset-top)",Tailwind 為 pt-[env(safe-area-inset-top)],Rust 中為 .p_safe_area();參見安全區域)依安全區域的邊界insets為畫面加上 padding,或在 Rust 中以 safe_area()、在 TSX 中以 safeArea() / safeAreaInsets() 讀取 insets 後自行套用。導覽堆疊中的頁面已經位於其標頭之下。
#由右至左
app 的版面配置方向依循系統語言,而 view 的 direction 樣式("ltr"、"rtl" 或 "inherit";Rust 中為 .direction(LayoutDirection::Rtl))會設定其子樹的方向。當 app 以由右至左排版時:
- 列從右側開始排列;
left與right維持原本的位置,與瀏覽器相同,樣式鍵與 class 皆然:paddingLeft、marginLeft、left、borderLeftWidth、borderTopLeftRadius、textAlign: "left"以及pl-4、ml-2、left-0、border-l、rounded-tl-lg、text-left仍在左側;- 邏輯屬性依循方向,inline start 為右側:
marginStart、marginEnd、paddingStart、paddingEnd、start、end、borderStartWidth、borderEndColor、borderTopStartRadius等、textAlign: "start"/"end"(class 為ps-4、ms-2、start-0、border-s、rounded-ss-lg、text-start;Rust 中為.ms(..)、.me(..)、.ps(..)、.pe(..)、.border_s(..)、.rounded_ss(..)等);marginHorizontal與paddingHorizontal則同時設定兩側; - 設定
textAlign: "auto"的文字會靠右對齊,且原生控制項會鏡像翻轉。
view()
.flex_row()
.gap_2()
.child(view().ms_4().rounded_ss(px(12.0)).size(px(44.0)).bg(rgb(0x54aeff)))
let rtl = signal(false);
view()
.direction(move || if rtl.get() { LayoutDirection::Rtl } else { LayoutDirection::Ltr })
.on_press(move |_: &()| rtl.set(!rtl.get()))
.child(text(move || if rtl.get() { "Right to left" } else { "Left to right" }))import { signal, Text, View } from "nsh";
const rtl = signal(false);
<View style={{ direction: rtl() ? "rtl" : "ltr" }}>
<View style={{ flexDirection: "row", gap: 8 }}>
<View style={{ marginStart: 16, borderTopStartRadius: 12, width: 44, height: 44, backgroundColor: "#54aeff" }} />
</View>
<View onPress={() => rtl.set(!rtl())}>
<Text>{rtl() ? "Right to left" : "Left to right"}</Text>
</View>
</View>方向的變更,無論是語言還是 view 的方向,都會立即生效,不需重新啟動。direction 樣式也可以讓單一 view 及其子元素維持自己的方向,例如由左至右顯示的電話號碼。在 Android 上,嵌入 NSH 的 app 需要在 manifest 中加入 android:supportsRtl="true",原生控制項才會鏡像翻轉。