本頁由機器翻譯,可能有錯誤。 閱讀英文原文

元素

Dialog

Dialog 會在應用程式其餘內容之上,以自己的原生視窗層呈現內容:在 iOS 和 Mac Catalyst 上是被 present 的 view controller,在 Android 上是 Dialog,在桌面平台與 web 上則是覆蓋整個視窗的一層。它可用於全螢幕流程、sheet 與對話框。系統自身的手勢(向下滑動 sheet、Android 返回鍵、Escape)都能運作,並由原生端決定。Rust 以 nsh_base::dialog() 建立,TSX 則使用來自 nsh/base 的 <Dialog>。

el-dialog.tsx
el-dialog.tsxLive
import { mount, signal, Text, View } from "nsh";
import { Button, Dialog, Switch } from "nsh/base";
import { button, buttonText, desktop, Inspector, Panel, Stage, tint, ui, wide } from "./palette";

const track = `${desktop ? "w-9" : "w-12"} rounded-full p-0.5 transition-colors motion-reduce:transition-none`;
const thumb = desktop ? "size-4 rounded-full transition-transform motion-reduce:transition-none checked:translate-x-4" : "size-5.5 rounded-full transition-transform motion-reduce:transition-none checked:translate-x-5";

function App() {
  const card = signal(false);
  const sheet = signal(false);
  const backdropCloses = signal(true);
  const cancels = signal(0);
  const log = signal("–");
  const openCard = () => (
    <Button onPress={() => card.set(true)} {...button("primary")}>
      <Text style={buttonText("primary")}>Open a card</Text>
    </Button>
  );
  const openSheet = () => (
    <Button onPress={() => sheet.set(true)} {...button()}>
      <Text style={buttonText()}>Open as a page sheet</Text>
    </Button>
  );
  const backdrop = () => (
    <Switch
      checked={backdropCloses()}
      onChange={({ checked }) => backdropCloses.set(checked)}
      class={wide() ? "flex-row items-center gap-2 self-center active:opacity-70" : "flex-row items-center gap-3 rounded-xl p-3 active:opacity-70"}
      style={wide() ? undefined : ui().row}
      trackClass={track}
      trackStyle={backdropCloses() ? ui().accentFill : ui().inset}
      thumbClass={thumb}
      thumbStyle={backdropCloses() ? { backgroundColor: ui().onAccent } : ui().raised}
    >
      <Text style={{ color: ui().text, flex: wide() ? undefined : 1, fontSize: desktop ? 13 : undefined }}>closeOnBackdropPress {String(backdropCloses())}</Text>
    </Switch>
  );
  const hint = desktop
    ? "Close with Escape or a click on the backdrop."
    : "Close with a tap on the backdrop, a swipe down or the back button. On iOS the sheet is a system pageSheet.";
  const state = () => `open: card ${String(card())} · sheet ${String(sheet())} · onCancel ${cancels()}×`;
  return (
    <View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 12 }}>
      <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>dialog</Text>

      {() =>
        wide() ? (
          <>
            <Text style={{ color: ui().muted }}>{hint}</Text>
            <View style={{ flex: 1, flexDirection: "row", gap: 16 }}>
              <Stage gap={16}>
                <View style={{ flexDirection: "row", justifyContent: "center", gap: 8 }}>
                  {openCard()}
                  {openSheet()}
                </View>
                {backdrop()}
              </Stage>
              <Inspector>
                <Panel title="open · onCancel">
                  <Text style={{ fontSize: 13, color: ui().text }}>{state()}</Text>
                </Panel>
                <Panel title="onOpenChange({ open, reason }) · onOpen" grow>
                  <Text style={{ fontSize: 13, fontWeight: "600", color: ui().accent }}>{log()}</Text>
                </Panel>
              </Inspector>
            </View>
          </>
        ) : (
          <View style={{ gap: 10 }}>
            {openCard()}
            {openSheet()}

            {backdrop()}

            <View style={{ ...ui().inset, borderRadius: 12, padding: 14, gap: 4 }}>
              <Text style={{ color: ui().muted, fontSize: 13 }}>{state()}</Text>
              <Text style={{ color: ui().accent, fontSize: 15, fontWeight: "600" }}>{log()}</Text>
            </View>
            <Text style={{ color: ui().faint, fontSize: 13 }}>{hint}</Text>
          </View>
        )
      }

      <Dialog
        open={card()}
        animation="fade"
        closeOnBackdropPress={backdropCloses()}
        onOpenChange={({ open, reason }) => {
          card.set(open);
          log.set(`onOpenChange({ open: ${open}, reason: "${reason}" })`);
        }}
        onCancel={() => cancels.update((n) => n + 1)}
        onOpen={() => log.set("onOpen: card")}
        backdropTestID="card-backdrop"
        backdropStyle={{ backgroundColor: tint("#000000", 0.45) }}
        style={{ ...ui().card, margin: "auto", width: 320, maxWidth: "90%", borderRadius: 18, padding: 20, gap: 12 }}
      >
        <Text style={{ color: ui().text, fontSize: 20, fontWeight: "700" }}>Delete this item?</Text>
        <Text style={{ color: ui().muted }}>
          {backdropCloses()
            ? "A press on the dimmed backdrop closes it."
            : "The backdrop only calls onCancel: close with a button."}
        </Text>
        <View style={{ flexDirection: "row", gap: 8, justifyContent: desktop ? "flex-end" : undefined }}>
          <Button
            onPress={() => {
              card.set(false);
              log.set("closed by the app: Keep");
            }}
            {...button("secondary", { style: desktop ? {} : { flex: 1 } })}
          >
            <Text style={buttonText()}>Keep</Text>
          </Button>
          <Button
            onPress={() => {
              card.set(false);
              log.set("closed by the app: Delete");
            }}
            {...button("danger", { style: desktop ? {} : { flex: 1 } })}
          >
            <Text style={buttonText("danger")}>Delete</Text>
          </Button>
        </View>
      </Dialog>

      <Dialog
        open={sheet()}
        presentation="pageSheet"
        onOpenChange={({ open, reason }) => {
          sheet.set(open);
          log.set(`onOpenChange({ open: ${open}, reason: "${reason}" })`);
        }}
        onCancel={() => cancels.update((n) => n + 1)}
        onOpen={() => log.set("onOpen: sheet")}
        backdropStyle={{ backgroundColor: tint("#000000", 0.3) }}
        // As tall as its content: a panel in the middle on the desktop, a
        // sheet along the bottom edge on a phone.
        style={
          desktop
            ? { backgroundColor: ui().page, margin: "auto", width: 480, maxWidth: "90%", maxHeight: "90%", borderRadius: 16 }
            : {
                backgroundColor: ui().page,
                marginTop: "auto",
                width: "100%",
                maxWidth: 560,
                maxHeight: "90%",
                alignSelf: "center",
                borderTopLeftRadius: 16,
                borderTopRightRadius: 16,
              }
        }
      >
        <View style={{ padding: 20, paddingTop: "calc(env(safe-area-inset-top) + 20px)", paddingRight: "calc(env(safe-area-inset-right) + 20px)", paddingBottom: "calc(env(safe-area-inset-bottom) + 20px)", paddingLeft: "calc(env(safe-area-inset-left) + 20px)", gap: 12 }}>
          <Text style={{ color: ui().text, fontSize: 22, fontWeight: "700" }}>A sheet</Text>
          <Text style={{ color: ui().muted }}>
            presentation="pageSheet": a system sheet on iOS that follows the finger when swiped down. Elsewhere the
            dialog is a layer over the window, and this panel is the app's own style.
          </Text>
          <Button onPress={() => sheet.set(false)} {...button("primary", { align: "flex-end" })}>
            <Text style={buttonText("primary")}>Close</Text>
          </Button>
        </View>
      </Dialog>
    </View>
  );
}

mount(App);

Dialog 自行管理行為,外觀則交由應用程式決定:它的 styles 會套用在 popup(容納 children 的 view)上,而在 TSX 中 backdropClass / backdropStyle 會在 popup 後方加上背景遮罩(backdrop)。

use nsh_base::{button, dialog};
use nsh_core::prelude::*;

/// A blue button with a white label.
fn primary(label: &'static str, on_press: impl Fn() + 'static) -> impl IntoElement {
    button()
        .on_press(on_press)
        .items_center()
        .rounded_lg()
        .bg(rgb(0x2563eb))
        .px_4()
        .py_3()
        .active(|s| s.opacity(0.7))
        .child(text(label).font_weight(FontWeight::SEMIBOLD).text_color(white()))
}

fn example() -> impl IntoElement {
    let open = signal(false);
    view()
        .flex_1()
        .justify_center()
        .p_6()
        .child(primary("Open", move || open.set(true)))
        .child(when(open, move || {
            dialog()
                .presentation(ModalPresentation::PageSheet)
                .on_cancel(move || open.set(false))
                .flex_1()
                .bg(white())
                .child(
                    view()
                        .flex_1()
                        .px_5()
                        .pt_safe_area_plus(px(20.0))
                        .pb_safe_area_plus(px(20.0))
                        .gap_3()
                        .child(text("A sheet").text_2xl().font_weight(FontWeight::BOLD))
                        .child(primary("Close", move || open.set(false))),
                )
        }))
}

在 TSX 中,當 open 不是 false 時顯示 Dialog,變成 false 時關閉。在 Rust 中,它存在於 view 中時會被呈現,離開 view 時則被關閉,因此由 when 持有它。無論哪種方式,它都會把 Dialog 的 safe-area insets 提供給其內容,內部的 env(safe-area-inset-*) 變數與 safeAreaInsets()(在 Rust 元件中為 cx.insets())會讀取這些值。同樣來自 nsh/base 的 Button 是由應用程式設定樣式的按壓目標。

nsh_core::prelude 也有一個較舊、已棄用的 dialog 函式:請像上面那樣以名稱 import nsh_base::dialog,明確的 import 會取代它。若需要系統的 alert 或 action sheet,請使用 AlertDialog。

#Props

PropRust型別預設值說明
open開啟時存在於 view 中(when(open, ..))booleantrue為 true 時顯示。
animation.animation(ModalAnimation::Fade)"slide" | "fade" | "none""slide"進入與離開的方式。
transitionShader.transition_shader(TransitionShader::new(program)){ source: string; uniforms?: Record<string, ShaderUniform>; duration?: number }無以 WGSL shader 取代其 animation 來進入與離開:shade(uv) 將後方內容讀為 sample_from,將 Dialog 讀為 sample_to,而 nsh.progress 會在 duration 毫秒(預設 350)內從 0 變到 1,關閉時則從 1 回到 0。當系統要求減少動態效果時,改用它自己的 animation。請參閱 Shader。
presentation.presentation(ModalPresentation::PageSheet)"fullScreen" | "pageSheet" | "formSheet""fullScreen"在 iOS 上的形式:fullScreen 以透明背景覆蓋整個螢幕;pageSheet 與 formSheet 是系統 sheet,後方內容仍可見(formSheet 在大螢幕上是較小、置中的 sheet)。
closeOnEscape.close_on_escape(..)booleantrueEscape 與 Android 返回鍵會以原生方式關閉它。
closeOnBackdropPress.close_on_backdrop_press(..)booleantrue按壓背景遮罩會關閉它。
closeOnSwipe.close_on_swipe(..)booleantrue向下滑動 sheet(iOS、手機瀏覽器)會以原生方式關閉它。
statusBar.status_bar(..){ foreground?, hidden?, animated? }無iOS 與 Android:Dialog 開啟期間的狀態列,優先於各頁面的設定(Status bar)。
onOpen.on_open(..)() => void已完成顯示。
onClose.on_close(..)() => void已消失:使用者關閉了它,或應用程式移除了它。
onCancel.on_cancel(..)() => void使用者嘗試關閉它(Escape、返回、按壓背景遮罩、向下滑動),無論 closeOn* 旗標是否允許它關閉。
onOpenChange.on_cancel(..)(e: { open: boolean; reason: "cancel" | "backdropPress" | "swipe" }) => void使用者已關閉它:請在此同步 open。在 Rust 中,on_cancel 會將 Dialog 從 view 中移除。
class、styleStyled 方法string、StyleProp<ViewStyle>popup:容納 children 的 view。
backdropClass、backdropStyle填滿 Dialog 的子 viewstring、StyleProp<ViewStyle>填滿 Dialog、位於 popup 後方的背景遮罩,只要設定其中任一個就會出現。
children.child(..)JSX.Element內容。
ios 鍵Rust型別預設值說明
supportedOrientations.supported_orientations(..)("portrait" | "portrait-upside-down" | "landscape" | "landscape-left" | "landscape-right")[]presenter 的設定Dialog 允許的方向。
android 鍵Rust型別預設值說明
statusBarTranslucent.status_bar_translucent(..)booleanfalse內容延伸到狀態列下方;否則從狀態列下方開始。

#開啟與關閉

Dialog 的狀態由應用程式持有。當使用者關閉 Dialog(Escape、Android 返回鍵、按壓背景遮罩、向下滑動 sheet)時,它會以原生方式關閉並通知應用程式,由應用程式將自己的狀態設為一致:TSX 的 onOpenChange({ open: false, reason })、Rust 的 on_cancel。在 TSX 中,只要 open 維持為 true,Dialog 就保持關閉,並在 open 從 false 變為 true 時再次開啟。

每個 closeOn* 旗標都是在使用者操作時於原生端讀取,因為主執行緒從不等待應用程式的程式碼。若要在關閉前先確認,請將這些旗標設為 false:此時嘗試關閉會呼叫 onCancel,再由應用程式自行關閉 Dialog(在 TSX 中將 open 設為 false,在 Rust 中將它從 view 中移除):

dialog()
    .presentation(ModalPresentation::PageSheet)
    .close_on_escape(false)
    .close_on_backdrop_press(false)
    .close_on_swipe(false)
    .on_cancel(move || ask_to_discard.set(true))
    .flex_1()
    .bg(white())
    .child(form())

每次嘗試關閉都會呼叫 onCancel,無論旗標是否允許 Dialog 關閉。

#帶有背景遮罩的 Dialog

使用預設 fullScreen 呈現方式的 Dialog 會顯示應用程式所繪製的內容:此處是一個變暗的背景遮罩,以及置中於其上的卡片。按壓背景遮罩會關閉它:

when(confirm, move || {
    dialog()
        .animation(ModalAnimation::Fade)
        .on_cancel(move || confirm.set(false))
        .flex_1()
        .child(
            // The backdrop: a press on it closes the dialog.
            view()
                .absolute()
                .inset_0()
                .bg(rgba(0x00000066))
                .on_press(move || confirm.set(false)),
        )
        .child(
            view()
                .m(auto())
                .w_80()
                .gap_3()
                .rounded_2xl()
                .bg(white())
                .p_5()
                .child(text("Delete this item?").text_xl().font_weight(FontWeight::BOLD))
                .child(
                    button()
                        .on_press(remove)
                        .items_center()
                        .rounded_lg()
                        .bg(rgb(0xdc2626))
                        .px_4()
                        .py_3()
                        .active(|s| s.opacity(0.7))
                        .child(text("Delete").font_weight(FontWeight::SEMIBOLD).text_color(white())),
                ),
        )
})

若需要系統的 alert 或 action sheet,請使用來自 nsh/base 的 AlertDialog。

#Ref 方法

無。

#平台說明

  • iOS 與 Mac Catalyst:由 presentation 決定形式。fullScreen 以透明背景覆蓋整個螢幕呈現;pageSheet 與 formSheet 是使用系統背景的系統 sheet,向下滑動時會跟隨手指(closeOnSwipe)。
  • Android:Dialog 填滿視窗,並顯示應用程式的 popup 與背景遮罩。返回鍵會先交給最上層的 Dialog,再交給 stack 與 BackHandler 監聽器。
  • 桌面平台(macOS、Windows、Linux、GPUI)與 web:Dialog 是覆蓋整個視窗的透明層,顯示應用程式的 popup 與背景遮罩。Escape 視為一次關閉嘗試。
  • supportedOrientations 屬於 iOS;statusBarTranslucent 屬於 Android。除非設定了 statusBarTranslucent,否則 Android Dialog 的內容會從狀態列下方開始。