Эта страница переведена машинным способом и может содержать ошибки. Читать оригинал на английском

Элементы

Dialog

Dialog показывает содержимое поверх остального приложения в собственном нативном оконном слое: это presented view controller на iOS и Mac Catalyst, Dialog на Android и слой поверх всего окна на десктопах и в вебе. Он используется для полноэкранных сценариев, листов (sheets) и диалогов. Системные жесты (смахивание листа вниз, кнопка «Назад» на Android, Escape) работают, и обрабатываются они нативно. В Rust его создают с помощью nsh_base::dialog(), в TSX — с помощью <Dialog> из nsh/base.

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);

Диалог сам управляет своим поведением, а внешний вид оставляет приложению: его стили оформляют popup (представление, в котором лежат дочерние элементы), а в TSX backdropClass / backdropStyle добавляют подложку позади него.

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, и закрывается, когда оно становится false. В Rust он презентуется, пока находится в представлении, и закрывается, когда покидает его, поэтому when удерживает его. В обоих случаях он передаёт своему содержимому отступы safe area диалога, которые читают переменные env(safe-area-inset-*) и safeAreaInsets() (cx.insets() в компоненте на Rust) внутри него. Button, также из nsh/base, — это цель нажатия, оформляемая приложением.

В nsh_core::prelude есть также более старая, устаревшая функция dialog: импортируйте nsh_base::dialog по имени, как показано выше, и явный импорт займёт её место. Для системного alert или action sheet используйте AlertDialog.

#Props

ПропRustТипПо умолчаниюОписание
openв представлении, пока открыт (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-шейдер вместо своего animation: shade(uv) читает то, что находится позади, как sample_from, а диалог — как sample_to, пока nsh.progress меняется от 0 до 1 за duration миллисекунд (по умолчанию 350), а при закрытии — от 1 обратно до 0. Если система просит уменьшить анимацию, используется собственный animation. См. Shader.
presentation.presentation(ModalPresentation::PageSheet)"fullScreen" | "pageSheet" | "formSheet""fullScreen"Его форма на iOS: fullScreen закрывает экран с прозрачным фоном; pageSheet и formSheet — системные листы, сквозь которые остаётся видно то, что позади (formSheet — более маленький лист по центру на больших экранах).
closeOnEscape.close_on_escape(..)booleantrueEscape и кнопка «Назад» на Android закрывают его нативно.
closeOnBackdropPress.close_on_backdrop_press(..)booleantrueНажатие на подложку закрывает его.
closeOnSwipe.close_on_swipe(..)booleantrueСмахивание листа вниз (iOS, браузеры на телефонах) закрывает его нативно.
statusBar.status_bar(..){ foreground?, hidden?, animated? }нетiOS и Android: строка состояния, пока диалог открыт; имеет приоритет над настройкой страниц (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 убирает диалог из представления.
class, styleметоды Styledstring, StyleProp<ViewStyle>Popup: представление, в котором лежат дочерние элементы.
backdropClass, backdropStyleдочернее представление, заполняющее диалогstring, StyleProp<ViewStyle>Подложка, заполняющая диалог позади popup; присутствует, если задан любой из этих пропов.
children.child(..)JSX.ElementСодержимое.
Ключ iosRustТипПо умолчаниюОписание
supportedOrientations.supported_orientations(..)("portrait" | "portrait-upside-down" | "landscape" | "landscape-left" | "landscape-right")[]как у представляющего контроллераОриентации, которые допускает диалог.
Ключ androidRustТипПо умолчаниюОписание
statusBarTranslucent.status_bar_translucent(..)booleanfalseСодержимое заходит под строку состояния; иначе оно начинается ниже неё.

#Открытие и закрытие

Состояние диалога принадлежит приложению. Когда пользователь закрывает диалог (Escape, кнопка «Назад» на Android, нажатие на подложку, смахивание листа вниз), он закрывается нативно и сообщает об этом приложению, которое приводит своё состояние в соответствие: onOpenChange({ open: false, reason }) в TSX, on_cancel в Rust. В TSX, пока open остаётся true, диалог остаётся закрытым и откроется снова, когда open перейдёт из false в true.

Каждый флаг closeOn* читается нативно в момент действия пользователя, поскольку главный поток никогда не ждёт кода приложения. Чтобы запросить подтверждение перед закрытием, установите флаги в false: тогда попытка закрыть вызовет onCancel, а приложение закроет диалог само (в TSX — установив open в false, в Rust — убрав его из представления):

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 вызывается при каждой попытке, независимо от того, позволяют ли флаги диалогу закрыться.

#Диалог с подложкой

Диалог с презентацией fullScreen по умолчанию показывает то, что рисует приложение: здесь это затемнённая подложка и карточка по центру поверх неё. Нажатие на подложку закрывает его:

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 используйте AlertDialog из nsh/base.

#Методы ref

Нет.

#Особенности платформ

  • iOS и Mac Catalyst: presentation выбирает форму. fullScreen презентуется поверх всего экрана с прозрачным фоном; pageSheet и formSheet — системные листы с системным фоном, которые следуют за пальцем при смахивании вниз (closeOnSwipe).
  • Android: диалог заполняет окно и показывает popup и подложку приложения. Кнопка «Назад» сначала обращается к самому верхнему диалогу, раньше стеков и слушателей BackHandler.
  • Десктопы (macOS, Windows, Linux, GPUI) и веб: диалог — это прозрачный слой поверх всего окна, который показывает popup и подложку приложения. Escape считается попыткой закрыть.
  • supportedOrientations относится к iOS, statusBarTranslucent — к Android. Содержимое диалога на Android начинается ниже строки состояния, если не задан statusBarTranslucent.