Struct Name 

pub struct Name { /* private fields */ }

A control’s accessible name and description.

React Aria’s useField builds aria-describedby by concatenating the description node’s id and the field-error node’s id (react-aria/dist/private/label/useField.js); the resulting accessible description is those two texts, in that order. gpui takes the text directly, so Self::field performs the same concatenation on the strings.

Implementations

impl Name

pub fn none() -> Self

No accessible name of its own — the node is named by its contents.

pub fn labelled(label: impl Into<SharedString>) -> Self

A control named by a literal string.

pub fn maybe(label: Option<impl Into<SharedString>>) -> Self

A control named by an optional string, unnamed when it is absent.

pub fn field( label: Option<&SharedString>, description: Option<&SharedString>, validity: &Validity, ) -> Self

The name and description a field’s own anatomy already computed.

label is the visible crate::field::Label’s text — React Aria points aria-labelledby at that element, so its text is the name. description is the crate::field::Description’s text, and the validation messages join it exactly when the field is invalid, which is exactly when React Aria’s FieldError renders and contributes its id to aria-describedby.

pub fn described(self, description: Option<impl Into<SharedString>>) -> Self

Replaces the description, for the controls that carry one without a validation story (a menu subtitle, a stepper hint).

pub fn prefixed(&self, prefix: &str) -> Self

Prefixes the name, the way useNumberField names its steppers “Increase {label}” rather than pointing at the field’s label alone.

pub fn label(&self) -> Option<&SharedString>

The accessible name, if any.

pub fn description(&self) -> Option<&SharedString>

The accessible description, if any.

pub fn is_empty(&self) -> bool

Whether this names anything at all. A control with no name is a control a screen reader announces by role only, which React Aria warns about in development (useToggle: “you must specify an aria-label”).

Trait Implementations

impl Clone for Name

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Name

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Name

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Name

impl PartialEq for Name

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Name