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

Элементы

Menu

Меню — это список действий, который открывает его триггер. Одна структура служит для всех устройств и показывается так, как ожидает каждое из них:

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);
  • На десктопах и в десктопных браузерах это всплывающее окно у триггера; Submenu раскрывается рядом со своим пунктом, когда указатель наводится на него или нажимает на него.
  • На телефонах и планшетах это панель (sheet) внизу экрана поверх подложки; Submenu показывает свои пункты в панели вместо пунктов меню, а ваша строка в начале ведёт назад.

Меню закрывают выбор пункта, нажатие снаружи, Escape, кнопка «Назад» в Android и жест выхода в VoiceOver. ContextMenu — это то же меню, которое открывается вторичной кнопкой (правым щелчком) в месте указателя или удержанием пальца на его триггере на сенсорных экранах.

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

Все пять компонентов приходят из nsh/base. Пункты сами попадают в своё меню, поэтому вы располагаете их свободно: группы во view, подписи, пункты, которые появляются и исчезают с помощью If. popupClass задаёт стиль всплывающего окна на десктопах и панели на телефонах; стиль, различающийся между ними, может сравнивать platform.idiom (nsh) с "desktop".

#Панели меню

Меню, триггеры которых являются пунктами одного Toolbar, образуют панель меню: пока одно из её меню открыто, наведение указателя на триггер другого меню открывает его вместо первого, а стрелки клавиатуры переключаются между триггерами.

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

На десктопах вторичная кнопка открывает его там, где находится указатель. На сенсорных экранах палец, удерживаемый на триггере, открывает его как панель; собственные нажатия триггера и окружающие его scroll view продолжают работать, а движение пальца отменяет удержание.

#Отмечаемые пункты

checked делает пункт отмечаемым: это либо настройка, которую показывает меню («Show sidebar»), либо, вместе с role="menuitemradio", один выбор из группы («Sort by»). Значение принадлежит вам: выбор пункта вызывает onSelect, вы задаёте следующее значение, и пункт его показывает. Пока пункт отмечен, действуют его классы checked: и checkedStyle, а также классы его индикатора: части перед содержимым (indicatorClass, indicatorStyle) вокруг отметки, которую вы задаёте (indicator). Отметка создаётся один раз и сохраняется; классы checked: индикатора показывают и скрывают её, как и собственные классы group-checked: отметки вместе с group в indicatorClass. closeOnSelect={false} оставляет меню открытым, поэтому настройка сразу показывает новое значение.

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

Отметка на конце строки помещается в содержимое и стилизуется классами group-checked: под group на пункте.

#Появление и исчезновение

На десктопах всплывающее окно появляется и исчезает с вашими переходами, как у Popover: popupStartingClass — его вид в первом кадре, popupEndingClass — его вид после закрытия, который сохраняется, пока выполняются классы transition-* из popupClass, а затем следует onClose. Подменю принимают те же виды и закрываются вместе со своим меню. Панель на телефонах выезжает и уезжает сама.

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

#Состояние открытия

Без open меню хранит собственное состояние (начиная с defaultOpen для Menu). С open состоянием владеет приложение и меняет его в onOpenChange({ open, reason }): "triggerPress", "select", "pressOutside", "backdropPress", "cancel", "contextMenu" или "longPress".

#Свойства

СвойствоRustТипПо умолчаниюОписание
open.open(..)booleanнетОткрыто, управляется приложением.
defaultOpen.default_open(..)booleanfalseОткрыто изначально, без open.
placement.placement(..)"top" | "bottom" | "left" | "right""bottom"Десктопы: сторона триггера, на которой оно располагается.
align.align(..)"start" | "center" | "end""start"Десктопы: как оно выравнивается относительно триггера.
offset.offset(..)number0Десктопы: зазор между триггером и всплывающим окном.
margin.margin(..)number0Десктопы: расстояние, которое оно выдерживает от краёв безопасной области.
popupClass, popupStyle.popup_class(..), .popup_style(..)string, StyleProp<ViewStyle>нетВсплывающее окно (десктопы) или панель (телефоны), а также всплывающие окна подменю.
popupStartingClass, popupStartingStyle.popup_starting_class(..), .popup_starting_style(..)string, StyleProp<ViewStyle>нетДесктопы: вид всплывающих окон в первом кадре, поверх их собственного.
popupEndingClass, popupEndingStyle.popup_ending_class(..), .popup_ending_style(..)string, StyleProp<ViewStyle>нетДесктопы: вид всплывающих окон после закрытия, сохраняемый, пока выполняются их переходы.
backdropClass, backdropStyle.backdrop_class(..), .backdrop_style(..)string, StyleProp<ViewStyle>нетТелефоны: подложка за панелью.
trigger.trigger(..)JSX.ElementнетТо, что открывает меню при нажатии. Пока меню открыто, действуют его классы aria-expanded: и expandedStyle.
children.child(..)JSX.ElementнетПункты, создаваемые при каждом открытии.

#ContextMenu

open, popupClass / popupStyle, начальный и конечный виды, backdropClass / backdropStyle, trigger и children — как у Menu, а также:

СвойствоRustТипПо умолчаниюОписание
disabled.disabled(..)booleanfalseВторичная кнопка и удерживаемые пальцы ничего не делают.
offset.offset(..)number0Десктопы: зазор между указателем и всплывающим окном.
margin.margin(..)number0Десктопы: расстояние, которое оно выдерживает от краёв безопасной области.
СвойствоRustТипПо умолчаниюОписание
disabled.disabled(..)booleanfalseНе может быть выбран; применяются стили disabled:.
checked.checked(..)booleanнетОтмечен или нет; делает пункт отмечаемым; значением владеет приложение.
checkedStyle.checked_style(..)StyleProp<ViewStyle>нетЕго стиль в отмеченном состоянии, в виде классов checked:.
role.role(..)AccessibilityRole"menuitemcheckbox" с checked, иначе "menuitem"Чем он является для программ чтения с экрана; "menuitemradio" для одного выбора из группы.
indicatorClass, indicatorStyle.indicator_class(..), .indicator_style(..)string, StyleProp<ViewStyle>нетИндикатор, часть перед содержимым; его классы checked: и disabled: следуют за пунктом.
indicator.indicator(..)JSX.ElementнетОтметка внутри индикатора.
closeOnSelect.close_on_select(..)booleantrueВыбор пункта закрывает меню.
accessibilityLabel.accessibility_label(..)stringнетЧто произносят программы чтения с экрана, если содержимого недостаточно.
children, class, style.child(..), методы стилянетЕго содержимое и вид, с состояниями hover:, active: и checked:.
СвойствоRustТипПо умолчаниюОписание
trigger.trigger(..)JSX.ElementнетПункт, который его открывает.
back.back(..)JSX.ElementнетТелефоны: строка над его пунктами, возвращающая к окружающим пунктам.
disabled.disabled(..)booleanfalseОно не открывается.
offset.offset(..)number0Десктопы: зазор между окружающим меню и его всплывающим окном.
children.child(..)JSX.ElementнетЕго пункты.

MenuSeparator — это view, которое вы стилизуете (class, style), он показывается вместе с пунктами своего уровня.

#События

СобытиеRustОписание
onOpenChange (Menu, ContextMenu).on_open_change(|e| ..)Меню открылось или закрылось, с указанием причины.
onOpen (Menu, ContextMenu).on_open(|| ..)Меню показано; в виде панели — после того, как она въехала.
onClose (Menu, ContextMenu).on_close(|| ..)Меню исчезло: в виде панели — после того, как она уехала, в виде всплывающего окна — после его выхода. Также когда его закрыло приложение.
onPosition (Menu, ContextMenu).on_position(|e| ..)Десктопы: всплывающее окно размещено: placement (сторона, на которой оно расположилось), bounds, available.
onCancel (Menu, ContextMenu).on_cancel(|| ..)Пользователь попытался закрыть меню, не сделав выбор (Escape или «Назад», нажатие снаружи или на подложке).
onSelect (MenuItem).on_select(|| ..)Пункт выбран; отмечаемый пункт запрашивает своё другое значение.

#Доступность

Для программ чтения с экрана всплывающее окно или панель — это меню, а его пункты — пункты меню; триггер сообщает, развёрнуто ли меню. Отмечаемый пункт — это пункт меню типа checkbox или radio, который читается как отмеченный или не отмеченный; его индикатор является частью пункта. В TSX триггер — это переданный вами элемент, Button или ваш собственный view: он сам принимает нажатия и состояние раскрытия, поэтому его собственные классы active: и activeStyle действуют, пока он нажат, и его собственный onPress тоже выполняется. На экране находятся только пункты показанного уровня, поэтому программы чтения с экрана читают то, что там есть.