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

元素

AlertDialog

AlertDialog 會顯示平台原生的警示對話框或動作表單(action sheet):在 iOS 與 Mac Catalyst 上是 UIAlertController,在 Android 上是 AlertDialog(動作表單則是清單對話框),在其他平台上則是採用該平台對話框外觀的警示對話框。AlertDialog.show(Rust 中為 alert_dialog() 的 .show())會回傳一個 promise(Rust 中為 future),並以 { action } 解析:即使用者所選動作的 id。 所有標籤都由應用程式提供,因此警示對話框會以應用程式所使用的語言,顯示應用程式所設定的內容。

el-alert-dialog.tsx
el-alert-dialog.tsxLive
import { mount, signal, Text, View } from "nsh";
import { AlertDialog, Button } from "nsh/base";
import { button, buttonText, desktop, focusRing, hoverFill, Inspector, Panel, size, Stage, ui, wide } from "./palette";

type Options = Parameters<typeof AlertDialog.show>[0];

// What each button shows, and what it is about.
const alerts: { label: string; detail: string; danger?: boolean; options: Options }[] = [
  {
    label: "Delete…",
    detail: "cancel + destructive roles",
    danger: true,
    options: {
      title: "Delete the photo?",
      description: "This cannot be undone.",
      actions: [
        { label: "Cancel", role: "cancel", id: "cancel" },
        { label: "Delete", role: "destructive", id: "delete" },
      ],
    },
  },
  {
    label: "Save changes…",
    detail: "three actions, closeOnEscape",
    options: {
      title: "Save changes?",
      description: "Your edits to “Trip notes” are not saved yet.",
      actions: [
        { label: "Don't save", role: "destructive", id: "discard" },
        { label: "Cancel", role: "cancel", id: "cancel" },
        { label: "Save", id: "save" },
      ],
      closeOnEscape: true,
    },
  },
  {
    label: "Share…",
    detail: 'presentation "actionSheet"',
    options: {
      title: "Share the photo",
      presentation: "actionSheet",
      actions: [
        { label: "Copy link", id: "copy" },
        { label: "Save", id: "save" },
        { label: "Delete", role: "destructive", id: "delete" },
        { label: "Cancel", role: "cancel", id: "cancel" },
      ],
    },
  },
];

function App() {
  const answer = signal("–");
  const shown = signal(0);
  const show = async (options: Options) => {
    shown.update((n) => n + 1);
    const { action } = await AlertDialog.show(options);
    answer.set(action === null ? "{ action: null } (closed without an action)" : `{ action: ${JSON.stringify(action)} }`);
  };
  const row = () => ({ ...ui().row, borderRadius: 12, padding: 14, gap: 2 });
  const hint = desktop ? "Escape or a click outside the action sheet closes it with { action: null }." : "A tap outside the action sheet closes it with { action: null }.";
  return (
    <View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 12 }}>
      <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>alert-dialog</Text>
      <Text style={{ color: ui().muted }}>The platform's own alert; every label comes from the app.</Text>

      {() =>
        wide() ? (
          <View style={{ flex: 1, flexDirection: "row", gap: 16 }}>
            {/* A row per alert: what it shows, and a button as wide as its label at the end. */}
            <Stage width={400}>
              <View style={{ ...ui().card, borderRadius: 14, overflow: "hidden" }}>
                <Each of={alerts}>
                  {(a, i) => (
                    <>
                      {i() > 0 ? <View style={{ height: 1, marginLeft: 12, backgroundColor: ui().line }} /> : null}
                      <View style={{ flexDirection: "row", alignItems: "center", gap: 12, height: size.row + 4, paddingHorizontal: 12 }}>
                        <Text style={{ flex: 1, fontSize: 13, color: ui().muted }}>{a().detail}</Text>
                        <Button onPress={() => show(a().options)} {...button()}>
                          <Text style={{ ...buttonText(), color: a().danger ? ui().down : ui().text }}>{a().label}</Text>
                        </Button>
                      </View>
                    </>
                  )}
                </Each>
              </View>
            </Stage>
            <Inspector>
              <Panel title={`AlertDialog.show resolved with (${shown()} shown)`}>
                <Text style={{ color: ui().accent, fontSize: 14, fontWeight: "600" }}>{answer()}</Text>
              </Panel>
              <Text style={{ color: ui().faint, fontSize: 12 }}>{hint}</Text>
            </Inspector>
          </View>
        ) : (
          <View style={{ gap: 10 }}>
            <Each of={alerts}>
              {(a) => (
                <Button onPress={() => show(a().options)} style={row()} activeStyle={{ opacity: 0.7 }} hoverStyle={hoverFill()} focusStyle={focusRing()}>
                  <Text style={{ color: a().danger ? ui().down : ui().text, fontSize: 16, fontWeight: "600" }}>{a().label}</Text>
                  <Text style={{ color: ui().muted, fontSize: 13 }}>{a().detail}</Text>
                </Button>
              )}
            </Each>

            <View style={{ ...ui().inset, borderRadius: 12, padding: 14, gap: 4, marginTop: 4 }}>
              <Text style={{ color: ui().muted, fontSize: 13 }}>AlertDialog.show resolved with ({shown()} shown)</Text>
              <Text style={{ color: ui().accent, fontSize: 16, fontWeight: "600" }}>{answer()}</Text>
            </View>
            <Text style={{ color: ui().faint, fontSize: 13 }}>{hint}</Text>
          </View>
        )
      }
    </View>
  );
}

mount(App);
use nsh_base::{alert_dialog, button};
use nsh_core::prelude::*;

fn app() -> impl IntoElement {
    let answer = signal(SharedString::from("–"));
    let confirm = move || {
        spawn(async move {
            let choice = alert_dialog()
                .title("Delete the photo?")
                .description("This cannot be undone.")
                .cancel("cancel", "Cancel")
                .destructive("delete", "Delete")
                .show()
                .await;
            let deleted = matches!(choice, Ok(r) if r.action.as_deref() == Some("delete"));
            answer.set(if deleted { "deleted" } else { "kept" }.into());
        });
    };
    view()
        .flex_1()
        .p_4()
        .pt(px(48.0))
        .gap_3()
        .child(
            button()
                .on_press(confirm)
                .rounded_lg()
                .bg(rgb(0xdc2626))
                .px_4()
                .py_3()
                .child(text("Delete…").text_color(white()).font_weight(FontWeight::SEMIBOLD)),
        )
        .child(text(answer))
}

若需要自訂外觀的對話框(卡片、表單、全螢幕流程),請使用 Dialog。

#AlertDialog.show

AlertDialog.show(options: AlertDialogOptions): Promise<AlertDialogResult>
alert_dialog().title(..).description(..).action(..).cancel(..).destructive(..).show()
    -> impl Future<Output = Result<AlertDialogResult, String>>

結果為 { action }(AlertDialogResult):即所選動作的 id;若對話框在未選擇任何動作的情況下關閉,則為 null(None)。關閉的情形包括:點擊對話框外部、按下 Escape 或返回鍵,前提是 closeOnBackdropPress 與 closeOnEscape 允許。若沒有任何動作,promise 會以 TypeError 拒絕(Rust 中為 Err)。在 Rust 中,nsh_base::alert_dialog() 會以每個選項、每個動作各一個方法來設定對話框,動作的呼叫順序即為顯示順序,並以 .show() 顯示對話框;請在任務(spawn)中等待其回應。

#Action sheets

動作表單接受相同的選項,只需使用 "actionSheet" 呈現方式:

use nsh_base::alert_dialog;
use nsh_core::prelude::*;

fn share() {
    spawn(async move {
        let choice = alert_dialog()
            .title("Share the photo")
            .action_sheet()
            .action("copy", "Copy link")
            .action("save", "Save")
            .destructive("delete", "Delete")
            .cancel("cancel", "Cancel")
            .show()
            .await;
        match choice.ok().and_then(|r| r.action).as_deref() {
            Some("copy") => { /* … */ }
            Some("save") => { /* … */ }
            Some("delete") => { /* … */ }
            _ => {} // "cancel", or closed without an action.
        }
    });
}

#AlertDialogOptions

FieldRustTypeDefaultDescription
title.title(..)string | null無顯示在說明文字上方。
description.description(..)string | null無顯示在標題下方。
actions.action(..)、.cancel(..)、.destructive(..),每個動作一個AlertDialogAction[]必填動作清單,依順序排列(至少一個;Android 警示對話框最多三個)。
presentation.action_sheet()"alert" | "actionSheet""alert"顯示於中央的警示對話框,或從底部彈出的動作表單(Android 上為清單對話框)。
closeOnEscape.close_on_escape(..)boolean | null警示對話框為 false,動作表單為 true按下 Escape 與 Android 返回鍵時,不選擇任何動作即關閉對話框。
closeOnBackdropPress.close_on_backdrop_press(..)boolean | null警示對話框為 false,動作表單為 true點擊對話框外部時,不選擇任何動作即關閉對話框。

#AlertDialogResult

FieldRustTypeDescription
actionactionstring | null(Option<SharedString>)所選動作的 id;若對話框在未選擇任何動作的情況下關閉,則為 null。

#AlertDialogAction

FieldRustTypeDefaultDescription
id方法的第一個引數string必填選取該動作時,show 會以 action 回報的值:即應用程式為該動作所取的名稱,無論標籤使用哪種語言,此名稱都保持不變。
label方法的第二個引數string必填顯示的文字內容。
role.action(..)、.cancel(..)、.destructive(..)"default" | "cancel" | "destructive""default"動作的語意:平台會依其角色決定位置與繪製方式(例如在 iOS 上,破壞性動作會顯示為紅色)。

#Platform notes

  • iOS:由 UIAlertController 負責排列動作。具有 "cancel" 角色的動作會被放置在 iOS 擺放取消動作的位置,動作表單則會將它獨立顯示在底部。在 iPad 與 Mac Catalyst 上,動作表單是一個彈出視窗(popover),其取消動作不顯示標題:點擊彈出視窗外部即可關閉,此時 action 為 null。
  • Android:AlertDialog 最多顯示三個動作,並依位置對應:最後一個動作為 positive 按鈕,前一個為 negative 按鈕,再前一個為 neutral 按鈕。動作表單是對話框中的動作清單,以點擊對話框外部或返回鍵取代取消動作(此時 action 為 null)。清單對話框會顯示 title;若動作表單沒有標題,則顯示 description。
  • Windows、Linux、GPUI 與 web:NSH 會以該平台的對話框外觀繪製警示對話框或動作表單。