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

Elementos

Menu

A menu é uma lista de ações que o seu gatilho abre. Uma única estrutura serve a todos os dispositivos, apresentada como cada um espera:

el-menu.tsx
el-menu.tsxLive
import { type JSX, mount, signal, Text, View } from "nsh";
import { ContextMenu, Menu, MenuItem, MenuSeparator, type OpenChangeReason, Submenu } from "nsh/base";
import { button, buttonText, desktop, Inspector, MenuMark, menuIndicator, Panel, PopIn, type PopupSide, Stage, tint, ui, wide } from "./palette";

/** A sheet at the bottom on phones; on desktops the popup's box keeps no
 * look, its `Items` have it. */
const surface = () =>
  desktop ? undefined : { ...ui().card, borderTopLeftRadius: 20, borderTopRightRadius: 20, paddingHorizontal: 10, paddingTop: 10, paddingBottom: 30 };

/** A menu's items: on desktops on a surface that grows out of the trigger's
 * side each time it opens (`PopIn`), on phones in the sheet that slides up. */
function Items(props: { side?: PopupSide; children: JSX.Element }) {
  if (!desktop) return props.children;
  return (
    <PopIn side={props.side} style={{ ...ui().card, borderRadius: 12, padding: 5, minWidth: 210 }}>
      {props.children}
    </PopIn>
  );
}

const backdrop = { backgroundColor: "rgba(0,0,0,0.45)" };
const rowHeight = () => (desktop ? 32 : 46);
const row = () => ({ flexDirection: "row" as const, alignItems: "center" as const, gap: 8, height: rowHeight(), paddingHorizontal: 10, borderRadius: 8 });

/**
 * One row. A checkable row (`checked`) leads with its mark: a check for a
 * setting, a dot for one choice of a group (`radio`), which fades in as the
 * app checks the item; rows of the same menu keep the mark's room so their
 * labels line up (`inset`).
 */
function Item(props: { label: string; onSelect?: () => void; checked?: boolean; radio?: boolean; inset?: boolean; disabled?: boolean; keepOpen?: boolean; danger?: boolean }) {
  return (
    <MenuItem
      onSelect={props.onSelect}
      disabled={props.disabled}
      checked={props.checked}
      role={props.radio ? "menuitemradio" : undefined}
      indicatorClass={menuIndicator}
      indicator={props.checked === undefined ? undefined : <MenuMark kind={props.radio ? "dot" : "check"} tint={ui().accent} />}
      closeOnSelect={!props.keepOpen}
      hoverStyle={{ backgroundColor: tint(ui().accent, 0.08), borderColor: tint(ui().accent, 0.24) }}
      activeStyle={{ backgroundColor: tint(ui().accent, 0.14), borderColor: tint(ui().accent, 0.34) }}
      disabledStyle={{ opacity: 0.35 }}
      style={{ ...row(), borderWidth: 1, borderColor: "transparent" }}
    >
      <If when={props.inset}>
        <View style={{ width: 16 }} />
      </If>
      <Text style={{ numberOfLines: 1, flexGrow: 1, flexShrink: 0, fontSize: 14, color: props.danger ? ui().down : ui().text }}>{props.label}</Text>
    </MenuItem>
  );
}

function Separator() {
  return <MenuSeparator style={{ height: 1, marginVertical: 4, marginHorizontal: 6, backgroundColor: ui().border }} />;
}

function Share(props: { onSelect: (what: string) => void }) {
  return (
    <Submenu
      offset={4}
      trigger={
        <View hoverStyle={{ backgroundColor: tint(ui().accent, 0.08), borderColor: tint(ui().accent, 0.24) }} activeStyle={{ backgroundColor: tint(ui().accent, 0.14), borderColor: tint(ui().accent, 0.34) }} style={{ ...row(), borderWidth: 1, borderColor: "transparent" }}>
          <Text style={{ numberOfLines: 1, flexGrow: 1, flexShrink: 0, fontSize: 14, color: ui().text }}>Share</Text>
          <Text style={{ fontSize: 14, color: ui().faint }}>›</Text>
        </View>
      }
      back={
        <View activeStyle={{ backgroundColor: tint(ui().accent, 0.14), borderColor: tint(ui().accent, 0.34) }} style={{ ...row(), borderWidth: 1, borderColor: "transparent" }}>
          <Text style={{ fontSize: 14, fontWeight: "600", color: ui().accent }}>‹ Share</Text>
        </View>
      }
    >
      <Items side="right">
        <Item label="Mail" onSelect={() => props.onSelect("Mail")} />
        <Item label="Messages" onSelect={() => props.onSelect("Messages")} />
        <Item label="Copy link" onSelect={() => props.onSelect("Copy link")} />
      </Items>
    </Submenu>
  );
}

/** A group's title: not an item, nothing to press. */
function Label(props: { text: string }) {
  return <Text style={{ fontSize: 12, fontWeight: "600", color: ui().faint, paddingHorizontal: 10, paddingTop: 6, paddingBottom: 2 }}>{props.text}</Text>;
}

const SORTS = ["Name", "Date modified", "Size"];

function App() {
  const last = signal("—");
  const reasons = signal<string[]>([]);
  const hidden = signal(false);
  const sidebar = signal(true);
  const minimap = signal(false);
  const sort = signal("Name");
  const pinned = signal(false);
  const changed = (name: string) => ({ open, reason }: { open: boolean; reason: OpenChangeReason }) =>
    reasons.set([`${name} ${open ? "opened" : "closed"} · ${reason}`, ...reasons()].slice(0, 8));
  const choose = (what: string) => last.set(what);
  const menu = () => (
    <Menu
      offset={4}
      margin={8}
      popupStyle={surface()}
      backdropStyle={backdrop}
      onOpenChange={changed("File")}
      trigger={
        <View {...button("secondary", { align: "flex-start" })}>
          <Text style={buttonText()}>File ▾</Text>
        </View>
      }
    >
      <Items>
        <Item label="New" onSelect={() => choose("New")} />
        <Item label="Open…" onSelect={() => choose("Open…")} />
        <Item label="Paste" disabled />
        <Separator />
        <Share onSelect={(what) => choose(`Share › ${what}`)} />
        <Separator />
        <Item label="Delete" danger onSelect={() => choose("Delete")} />
      </Items>
    </Menu>
  );
  const view = () => (
    <Menu
      offset={4}
      margin={8}
      popupStyle={surface()}
      backdropStyle={backdrop}
      onOpenChange={changed("View")}
      trigger={
        <View {...button("secondary", { align: "flex-start" })}>
          <Text style={buttonText()}>View ▾</Text>
        </View>
      }
    >
      <Items>
        {/* Settings keep the menu open: each shows its new value at once. */}
        <Item label="Show sidebar" checked={sidebar()} keepOpen onSelect={() => sidebar.set(!sidebar())} />
        <Item label="Show minimap" checked={minimap()} keepOpen onSelect={() => minimap.set(!minimap())} />
        <Item label="Show hidden files" checked={hidden()} keepOpen onSelect={() => hidden.set(!hidden())} />
        <Separator />
        <Label text="Sort by" />
        {/* One choice of a group: choosing closes the menu. */}
        <Each of={SORTS}>{(by) => <Item label={by()} radio checked={sort() === by()} onSelect={() => sort.set(by())} />}</Each>
      </Items>
    </Menu>
  );
  const context = () => (
    <ContextMenu
      margin={8}
      popupStyle={surface()}
      backdropStyle={backdrop}
      onOpenChange={changed("Context")}
      trigger={
        <View
          style={{
            height: wide() ? 220 : 150,
            borderRadius: 14,
            borderWidth: 2,
            borderStyle: "dashed",
            borderColor: ui().faint,
            alignItems: "center",
            justifyContent: "center",
            gap: 4,
          }}
        >
          <Text style={{ fontSize: 15, fontWeight: "600", color: ui().text }}>{pinned() ? "ContextMenu · pinned" : "ContextMenu"}</Text>
          <Text style={{ fontSize: 13, color: ui().muted }}>{desktop ? "Right click here" : "Hold a finger here"}</Text>
        </View>
      }
    >
      <Items>
        <Item label="Pinned" checked={pinned()} onSelect={() => pinned.set(!pinned())} />
        <Item label="Copy" inset onSelect={() => choose("Copy")} />
        <Item label="Rename" inset onSelect={() => choose("Rename")} />
        <Separator />
        <Item label="Delete" inset danger onSelect={() => choose("Delete")} />
      </Items>
    </ContextMenu>
  );
  const panels = () => (
    <>
      <Panel title="onSelect · checked">
        <Text style={{ fontSize: 13, color: ui().text }}>{last()}</Text>
        <Text style={{ fontSize: 13, color: ui().muted }}>
          sidebar {sidebar() ? "on" : "off"} · minimap {minimap() ? "on" : "off"} · hidden files {hidden() ? "shown" : "hidden"} · by {sort()} · {pinned() ? "pinned" : "not pinned"}
        </Text>
      </Panel>
      <Panel title="onOpenChange({ open, reason })" grow>
        <View style={{ gap: 2 }}>
          <Each of={reasons()}>{(e, i) => <Text style={{ fontSize: 12, color: i() === 0 ? ui().text : ui().faint }}>{e()}</Text>}</Each>
        </View>
      </Panel>
    </>
  );
  return (
    <View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 14 }}>
      <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>menu</Text>
      <Text style={{ color: ui().muted }}>
        {desktop ? "Click File; hover Share to open its submenu. View has settings and a choice of one. Right click the box below" : "Tap File: a sheet; Share shows its items in place. View has settings and a choice of one"}
      </Text>

      {() =>
        wide() ? (
          <View style={{ flex: 1, flexDirection: "row", gap: 16 }}>
            <Stage>
              <View style={{ flexDirection: "row", gap: 8 }}>
                {menu()}
                {view()}
              </View>
              {context()}
            </Stage>
            <Inspector>{panels()}</Inspector>
          </View>
        ) : (
          <>
            <View style={{ flexDirection: "row", gap: 8 }}>
              {menu()}
              {view()}
            </View>
            {context()}
            {panels()}
          </>
        )
      }
    </View>
  );
}

mount(App);
  • Em desktops e em navegadores desktop, um popup junto ao gatilho; um Submenu se abre em cascata ao lado do seu item quando o ponteiro passa sobre ele ou o pressiona.
  • Em celulares e tablets, uma sheet na parte inferior da tela, sobre um backdrop; um Submenu mostra seus itens na sheet no lugar dos itens do menu, com uma linha sua levando de volta.

Escolher um item, tocar fora, Escape, o botão voltar do Android e o gesto de escape do VoiceOver fecham o menu. ContextMenu é o mesmo menu aberto pelo botão secundário (um clique direito) no ponteiro, ou por um dedo mantido sobre o gatilho em telas sensíveis ao toque.

use nsh_base::{menu, menu_item, menu_separator, submenu};
use nsh_core::prelude::*;

fn item(label: &'static str, on_select: impl Fn() + 'static) -> impl IntoElement {
    menu_item()
        .on_select(on_select)
        .px_3()
        .py_2()
        .rounded_md()
        .child(text(label))
}

fn file_menu() -> impl IntoElement {
    menu()
        .offset(px(4.0))
        .trigger(view().px_3().py_2().child(text("File")))
        .child(item("New", || log::info!("new")))
        .child(item("Open…", || log::info!("open")))
        .child(menu_separator().h(px(1.0)).my_1().bg(rgb(0xe5e7eb)))
        .child(
            submenu()
                .trigger(view().px_3().py_2().child(text("Share ›")))
                .back(view().px_3().py_2().child(text("‹ Back")))
                .child(item("Mail", || log::info!("mail")))
                .child(item("Copy link", || log::info!("link"))),
        )
}

Todos os cinco vêm de nsh/base. Os itens chegam ao menu por conta própria, então você os organiza livremente: grupos em views, rótulos, itens que aparecem e somem com If. popupClass estiliza o popup nos desktops e a sheet nos celulares; um estilo que difere entre eles pode comparar platform.idiom (nsh) com "desktop".

#Barras de menu

Menus cujos gatilhos são itens de um mesmo Toolbar formam uma barra de menu: com um dos menus aberto, o ponteiro sobre o gatilho de outro menu abre esse menu no lugar, e as setas do teclado se movem entre os gatilhos.

<Toolbar accessibilityLabel="Menu bar">
  <Menu trigger={<View><Text>File</Text></View>}>{/* … */}</Menu>
  <Menu trigger={<View><Text>Edit</Text></View>}>{/* … */}</Menu>
</Toolbar>

import { ContextMenu, MenuItem } from "nsh/base";

<ContextMenu
  popupClass="min-w-40 rounded-lg bg-white p-1 shadow-lg"
  backdropClass="bg-black/40"
  trigger={<PhotoTile photo={photo} />}
>
  <MenuItem onSelect={() => share(photo)}><Text>Share</Text></MenuItem>
  <MenuItem onSelect={() => remove(photo)}><Text>Delete</Text></MenuItem>
</ContextMenu>

Nos desktops, o botão secundário o abre onde o ponteiro está. Em telas sensíveis ao toque, um dedo mantido sobre o gatilho o abre como uma sheet; os toques do próprio gatilho e as scroll views ao redor continuam funcionando, e mover o dedo cancela a pressão prolongada.

#Itens marcáveis

checked torna um item marcável: uma configuração que o menu exibe (“Mostrar barra lateral”) ou, com role="menuitemradio", uma escolha de um grupo (“Ordenar por”). O valor é seu: escolher o item chama onSelect, você define o próximo valor, e o item o exibe. Enquanto está marcado, suas classes checked: e checkedStyle se aplicam, assim como as do seu indicador: a parte antes do conteúdo (indicatorClass, indicatorStyle) em torno da marca que você fornece (indicator). A marca é criada uma vez e mantida; as classes checked: do indicador a mostram e a ocultam, ou as classes group-checked: da própria marca com group em indicatorClass. closeOnSelect={false} mantém o menu aberto, de modo que uma configuração mostra seu novo valor imediatamente.

use nsh_base::{menu, menu_item};
use nsh_core::{element::StyleRefinement, prelude::*};

fn view_menu(sidebar: Signal<bool>, sort: Signal<&'static str>) -> impl IntoElement {
    // The indicator part shows the mark while the item is checked.
    let part = |s: StyleRefinement| s.w(px(16.0)).opacity(0.0).checked(|s| s.opacity(1.0));
    let by = move |label: &'static str| {
        menu_item()
            .role(AccessibilityRole::MenuItemRadio)
            .checked(move || Some(sort.get() == label))
            .indicator_style(part)
            .indicator(text("✓"))
            .on_select(move || sort.set(label))
            .flex_row()
            .gap_2()
            .px_3()
            .py_2()
            .child(text(label))
    };
    menu()
        .trigger(view().px_3().py_2().child(text("View")))
        .child(
            menu_item()
                .checked(move || Some(sidebar.get()))
                .close_on_select(false)
                .indicator_style(part)
                .indicator(text("✓"))
                .on_select(move || sidebar.set(!sidebar.get_untracked()))
                .flex_row()
                .gap_2()
                .px_3()
                .py_2()
                .child(text("Show sidebar")),
        )
        .child(by("Name"))
        .child(by("Date modified"))
}

Uma marca na borda final vai no conteúdo, estilizada com classes group-checked: sob group no item.

#Entrada e saída

Nos desktops, o popup entra e sai com as suas transições, como as de um Popover: popupStartingClass é sua aparência no primeiro frame, popupEndingClass sua aparência depois de fechado, que ele mantém enquanto as classes transition-* de popupClass rodam, e onClose vem em seguida. Os submenus assumem as mesmas aparências e fecham junto com o seu menu. A sheet dos celulares desliza para dentro e para fora por conta própria.

<Menu
  popupClass="min-w-40 rounded-lg bg-white p-1 shadow-lg transition-all duration-100"
  popupStartingClass="opacity-0 -translate-y-1"
  popupEndingClass="opacity-0"
  trigger={<Text>File</Text>}
>
  <MenuItem onSelect={newFile}><Text>New</Text></MenuItem>
</Menu>

#Estado de abertura

Sem open, um menu mantém seu próprio estado (a partir de defaultOpen para Menu). Com open, o app é o dono do estado e o altera em onOpenChange({ open, reason }): "triggerPress", "select", "pressOutside", "backdropPress", "cancel", "contextMenu" ou "longPress".

#Props

Prop Rust Tipo Padrão Descrição
open .open(..) boolean nenhum Aberto, controlado pelo app.
defaultOpen .default_open(..) boolean false Aberto inicialmente, sem open.
placement .placement(..) "top" | "bottom" | "left" | "right" "bottom" Desktops: o lado do gatilho em que ele fica.
align .align(..) "start" | "center" | "end" "start" Desktops: como ele se alinha ao gatilho.
offset .offset(..) number 0 Desktops: o espaço entre o gatilho e o popup.
margin .margin(..) number 0 Desktops: a distância que ele mantém das bordas da área segura.
popupClass, popupStyle .popup_class(..), .popup_style(..) string, StyleProp<ViewStyle> nenhum O popup (desktops) ou a sheet (celulares), e os popups dos submenus.
popupStartingClass, popupStartingStyle .popup_starting_class(..), .popup_starting_style(..) string, StyleProp<ViewStyle> nenhum Desktops: a aparência dos popups no primeiro frame, sobre a sua própria.
popupEndingClass, popupEndingStyle .popup_ending_class(..), .popup_ending_style(..) string, StyleProp<ViewStyle> nenhum Desktops: a aparência dos popups depois de fechados, mantida enquanto suas transições rodam.
backdropClass, backdropStyle .backdrop_class(..), .backdrop_style(..) string, StyleProp<ViewStyle> nenhum Celulares: o backdrop atrás da sheet.
trigger .trigger(..) JSX.Element nenhum O que o abre quando pressionado. Enquanto o menu está aberto, suas classes aria-expanded: e expandedStyle se aplicam.
children .child(..) JSX.Element nenhum Os itens, criados a cada abertura.

#ContextMenu

open, popupClass / popupStyle, as aparências inicial e final, backdropClass / backdropStyle, trigger e children como em Menu, e:

Prop Rust Tipo Padrão Descrição
disabled .disabled(..) boolean false O botão secundário e os dedos mantidos não fazem nada.
offset .offset(..) number 0 Desktops: o espaço entre o ponteiro e o popup.
margin .margin(..) number 0 Desktops: a distância que ele mantém das bordas da área segura.
Prop Rust Tipo Padrão Descrição
disabled .disabled(..) boolean false Não pode ser escolhido; os estilos disabled: se aplicam.
checked .checked(..) boolean nenhum Marcado ou não, o que o torna um item marcável; pertence ao app.
checkedStyle .checked_style(..) StyleProp<ViewStyle> nenhum Seu estilo enquanto marcado, como classes checked:.
role .role(..) AccessibilityRole "menuitemcheckbox" com checked, senão "menuitem" O que ele é para leitores de tela; "menuitemradio" para uma escolha de um grupo.
indicatorClass, indicatorStyle .indicator_class(..), .indicator_style(..) string, StyleProp<ViewStyle> nenhum O indicador, a parte antes do conteúdo; suas classes checked: e disabled: acompanham o item.
indicator .indicator(..) JSX.Element nenhum A marca dentro do indicador.
closeOnSelect .close_on_select(..) boolean true Escolhê-lo fecha o menu.
accessibilityLabel .accessibility_label(..) string nenhum O que os leitores de tela dizem, quando o conteúdo não basta.
children, class, style .child(..), métodos de estilo nenhum Seu conteúdo e aparência, com os estados hover:, active: e checked:.
Prop Rust Tipo Padrão Descrição
trigger .trigger(..) JSX.Element nenhum O item que o abre.
back .back(..) JSX.Element nenhum Celulares: a linha acima dos seus itens que volta aos itens ao redor.
disabled .disabled(..) boolean false Não abre.
offset .offset(..) number 0 Desktops: o espaço entre o menu ao redor e o seu popup.
children .child(..) JSX.Element nenhum Seus itens.

MenuSeparator é uma view que você estiliza (class, style), exibida junto com os itens do seu nível.

#Eventos

Evento Rust Descrição
onOpenChange (Menu, ContextMenu) .on_open_change(|e| ..) Abriu ou fechou, com o motivo.
onOpen (Menu, ContextMenu) .on_open(|| ..) Está visível; como sheet, depois de entrar.
onClose (Menu, ContextMenu) .on_close(|| ..) Sumiu: como sheet, depois de sair; como popup, depois da sua saída. Também quando o app o fechou.
onPosition (Menu, ContextMenu) .on_position(|e| ..) Desktops: o popup foi posicionado: placement (o lado em que ficou), bounds, available.
onCancel (Menu, ContextMenu) .on_cancel(|| ..) O usuário tentou fechá-lo sem escolher (Escape ou voltar, um toque fora ou no backdrop).
onSelect (MenuItem) .on_select(|| ..) O item foi escolhido; um item marcável pede o seu outro valor.

#Acessibilidade

O popup ou a sheet é um menu e seus itens são itens de menu para leitores de tela; o gatilho informa se o menu está expandido. Um item marcável é um item de menu do tipo checkbox ou radio, lido como marcado ou não marcado; seu indicador faz parte do item. Em TSX, o gatilho é o elemento que você passa, um Button ou uma view sua: ele recebe os toques e o estado expandido por conta própria, então suas classes active: e activeStyle aparecem enquanto ele está pressionado, e o seu próprio onPress também é executado. Apenas os itens do nível exibido estão na tela, então os leitores de tela leem o que está ali.