Esta página foi traduzida automaticamente e pode conter erros. Ler o original em inglês

Elementos

Dialog

A diálogo apresenta conteúdo sobre o restante do app em sua própria camada de janela nativa: um view controller apresentado no iOS e no Mac Catalyst, um Dialog no Android, uma camada sobre a janela inteira nos desktops e na web. É usado para fluxos em tela cheia, sheets e caixas de diálogo. Os gestos do próprio sistema (deslizar um sheet para baixo, o botão Voltar do Android, Escape) funcionam e são decididos nativamente. Em Rust, cria-se um com nsh_base::dialog(); em TSX, com <Dialog> de 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);

O diálogo é dono do seu comportamento e deixa a aparência a cargo do app: seus estilos estilizam o popup (a view que contém os filhos), e em TSX backdropClass / backdropStyle adicionam um backdrop atrás dele.

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))),
                )
        }))
}

Em TSX, o diálogo é exibido enquanto open não for false e fechado quando se torna false. Em Rust, ele é apresentado enquanto estiver na view e dispensado quando sai dela, de modo que when o mantém. Em ambos os casos, ele entrega ao seu conteúdo os insets de área segura do diálogo, que as variáveis env(safe-area-inset-*) e safeAreaInsets() (cx.insets() em um componente Rust) lidas dentro dele refletem. Button, também de nsh/base, é um alvo de toque estilizado pelo app.

nsh_core::prelude também tem uma função dialog mais antiga, obsoleta: importe nsh_base::dialog pelo nome, como acima, e o import explícito toma o seu lugar. Para o alerta ou action sheet do sistema, use AlertDialog.

#Props

Prop Rust Tipo Padrão Descrição
open na view enquanto aberto (when(open, ..)) boolean true Exibido enquanto for true.
animation .animation(ModalAnimation::Fade) "slide" | "fade" | "none" "slide" Como ele entra e sai.
transitionShader .transition_shader(TransitionShader::new(program)) { source: string; uniforms?: Record<string, ShaderUniform>; duration?: number } nenhum Ele entra e sai por meio de um shader WGSL no lugar do seu animation: shade(uv) lê o que está atrás como sample_from e o diálogo como sample_to enquanto nsh.progress vai de 0 a 1 ao longo de duration milissegundos (350 por padrão), e de 1 de volta a 0 ao fechar. Quando o sistema pede menos movimento, ele usa o seu próprio animation. Veja Shader.
presentation .presentation(ModalPresentation::PageSheet) "fullScreen" | "pageSheet" | "formSheet" "fullScreen" Sua forma no iOS: fullScreen cobre a tela com um fundo transparente; pageSheet e formSheet são sheets do sistema que mantêm visível o que está atrás (formSheet é um sheet menor e centralizado em telas grandes).
closeOnEscape .close_on_escape(..) boolean true Escape e o botão Voltar do Android o fecham nativamente.
closeOnBackdropPress .close_on_backdrop_press(..) boolean true Um toque no backdrop o fecha.
closeOnSwipe .close_on_swipe(..) boolean true Deslizar um sheet para baixo (iOS, navegadores de celular) o fecha nativamente.
statusBar .status_bar(..) { foreground?, hidden?, animated? } nenhum iOS e Android: a barra de status enquanto o diálogo está aberto, sobrepondo a das páginas (Status bar).
onOpen .on_open(..) () => void Terminou de aparecer.
onClose .on_close(..) () => void Foi embora: o usuário o fechou ou o app o removeu.
onCancel .on_cancel(..) () => void O usuário tentou fechá-lo (Escape, Voltar, um toque no backdrop, um deslize para baixo), quer uma flag closeOn* o tenha deixado fechar ou não.
onOpenChange .on_cancel(..) (e: { open: boolean; reason: "cancel" | "backdropPress" | "swipe" }) => void O usuário o fechou: mantenha open sincronizado aqui. Em Rust, on_cancel remove o diálogo da view.
class, style métodos Styled string, StyleProp<ViewStyle> O popup: a view que contém os filhos.
backdropClass, backdropStyle uma view filha que preenche o diálogo string, StyleProp<ViewStyle> Um backdrop que preenche o diálogo atrás do popup, presente quando qualquer um dos dois é definido.
children .child(..) JSX.Element O conteúdo.
Chave ios Rust Tipo Padrão Descrição
supportedOrientations .supported_orientations(..) ("portrait" | "portrait-upside-down" | "landscape" | "landscape-left" | "landscape-right")[] a do apresentador As orientações que o diálogo permite.
Chave android Rust Tipo Padrão Descrição
statusBarTranslucent .status_bar_translucent(..) boolean false O conteúdo alcança a área sob a barra de status; caso contrário, começa abaixo dela.

#Abertura e fechamento

O estado do diálogo pertence ao app. Quando o usuário fecha o diálogo (Escape, o botão Voltar do Android, um toque no backdrop, um sheet deslizado para baixo), ele fecha nativamente e avisa o app, que ajusta o seu estado para corresponder: onOpenChange({ open: false, reason }) em TSX, on_cancel em Rust. Em TSX, enquanto open permanecer true, o diálogo permanece fechado, e ele abre novamente quando open passa de false para true.

Cada flag closeOn* é lida nativamente quando o usuário age, já que a thread principal nunca espera pelo código do app. Para confirmar antes de fechar, defina as flags como false: a tentativa então chama onCancel, e o app fecha o diálogo por conta própria (em TSX definindo open como false, em Rust retirando-o da 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 é chamado a cada tentativa, quer as flags deixem o diálogo fechar ou não.

#Um diálogo com backdrop

Um diálogo com a apresentação fullScreen padrão exibe o que o app desenha: aqui, um backdrop escurecido e um card centralizado sobre ele. Um toque no backdrop o fecha:

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())),
                ),
        )
})

Para o alerta ou action sheet do sistema, use AlertDialog de nsh/base.

#Métodos de ref

Nenhum.

#Notas de plataforma

  • iOS e Mac Catalyst: presentation escolhe a forma. fullScreen apresenta sobre a tela inteira com um fundo transparente; pageSheet e formSheet são sheets do sistema com o fundo do sistema, que acompanham o dedo ao serem deslizados para baixo (closeOnSwipe).
  • Android: o diálogo preenche a janela e exibe o popup e o backdrop do app. O botão Voltar vai primeiro para o diálogo mais acima, antes das pilhas e dos listeners de BackHandler.
  • Desktops (macOS, Windows, Linux, GPUI) e web: o diálogo é uma camada transparente sobre a janela inteira que exibe o popup e o backdrop do app. Escape é uma tentativa de fechar.
  • supportedOrientations é do iOS; statusBarTranslucent é do Android. O conteúdo de um diálogo no Android começa abaixo da barra de status, a menos que statusBarTranslucent esteja definido.