Skip to main content

Placement

Enum Placement 

Source
pub enum Placement {
Show 22 variants Bottom, BottomStart, BottomLeft, BottomEnd, BottomRight, Top, TopStart, TopLeft, TopEnd, TopRight, Left, LeftTop, LeftBottom, Right, RightTop, RightBottom, Start, StartTop, StartBottom, End, EndTop, EndBottom,
}
Expand description

placement — where a floating panel sits relative to its trigger.

The full React Aria union v3 forwards: both physical spellings ("bottom left", "bottom right") and logical aliases ("start", "end top", …) for every side. This port has no RTL mode, so the logical start/end aliases resolve to the same pixels as their left/right spellings; the spellings stay distinct values so ALL enumerates the whole 22-value vocabulary a caller can name.

Variants§

§

Bottom

"bottom" — below the trigger, centred.

§

BottomStart

"bottom start" — below the trigger, flush with its start edge.

§

BottomLeft

"bottom left" — below the trigger, flush with its left edge; the physical spelling of Placement::BottomStart in this LTR-only port.

§

BottomEnd

"bottom end" — below the trigger, flush with its end edge.

§

BottomRight

"bottom right" — below the trigger, flush with its right edge; the physical spelling of Placement::BottomEnd here.

§

Top

"top" — above the trigger, centred.

§

TopStart

"top start" — above the trigger, flush with its start edge.

§

TopLeft

"top left" — above the trigger, flush with its left edge; the physical spelling of Placement::TopStart here.

§

TopEnd

"top end" — above the trigger, flush with its end edge.

§

TopRight

"top right" — above the trigger, flush with its right edge; the physical spelling of Placement::TopEnd here.

§

Left

"left" — beside the trigger’s left edge, vertically centred.

§

LeftTop

"left top" — beside the left edge, flush with the trigger’s top.

§

LeftBottom

"left bottom" — beside the left edge, flush with the trigger’s bottom.

§

Right

"right" — beside the trigger’s right edge, vertically centred.

§

RightTop

"right top" — beside the right edge, flush with the trigger’s top.

§

RightBottom

"right bottom" — beside the right edge, flush with the trigger’s bottom.

§

Start

"start" — the logical spelling of Placement::Left in an LTR-only port.

§

StartTop

"start top" — the logical spelling of Placement::LeftTop here.

§

StartBottom

"start bottom" — the logical spelling of Placement::LeftBottom here.

§

End

"end" — the logical spelling of Placement::Right in an LTR-only port.

§

EndTop

"end top" — the logical spelling of Placement::RightTop here.

§

EndBottom

"end bottom" — the logical spelling of Placement::RightBottom here.

Implementations§

Source§

impl Placement

Source

pub const ALL: [Placement; 22]

Every placement, in declaration order.

Source

pub fn label(self) -> &'static str

A human-readable label for this placement.

Source

pub fn is_above(self) -> bool

Whether the panel opens upward.

Source

pub fn is_side(self) -> bool

Whether the panel sits beside the trigger rather than above or below.

Source

pub fn is_start_side(self) -> bool

Whether the panel opens on the trigger’s start side — the left edge, because this port has no RTL mode.

Source

pub fn align(self) -> PlacementAlign

The alignment along the trigger’s cross axis: horizontal for the top and bottom placements, vertical for the side ones.

Trait Implementations§

Source§

impl Clone for Placement

Source§

fn clone(&self) -> Placement

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Placement

Source§

impl Debug for Placement

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Placement

Source§

fn default() -> Placement

Returns the “default value” for a type. Read more
Source§

impl Eq for Placement

Source§

impl PartialEq for Placement

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Placement

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more