Skip to main content

OverlayTokens

Struct OverlayTokens 

Source
pub struct OverlayTokens {
Show 21 fields pub sheet_corner_radius: u16, pub dialog_corner_radius: u16, pub popup_corner_radius: u16, pub sheet_elevation: u16, pub popup_elevation: u16, pub dialog_elevation: u16, pub sheet_padding: u16, pub dialog_padding: u16, pub popup_padding: u16, pub scrim: u32, pub toast_elevation: u16, pub toast_corner_radius: u16, pub toast_container_light: u32, pub toast_container_dark: u32, pub toast_content_light: u32, pub toast_content_dark: u32, pub toast_border_width: Option<u16>, pub toast_padding_horizontal: u16, pub toast_padding_vertical: u16, pub toast_font_size: u16, pub toast_line_height: u16,
}
Expand description

Application-level overlay theme tokens for Dialog, Menu, Dropdown, Sheet and the transient message. Every measure is in dp, and 0 keeps the design system’s own.

Fields§

§sheet_corner_radius: u16§dialog_corner_radius: u16§popup_corner_radius: u16§sheet_elevation: u16§popup_elevation: u16§dialog_elevation: u16§sheet_padding: u16§dialog_padding: u16§popup_padding: u16§scrim: u32§toast_elevation: u16

How high the transient message floats, which is how much shadow it casts.

§toast_corner_radius: u16

The corner radius of the transient message.

§toast_container_light: u32

The transient message’s fill in the light scheme, as ARGB; 0 keeps the design system’s.

§toast_container_dark: u32

The transient message’s fill in the dark scheme, as ARGB; 0 keeps the design system’s.

§toast_content_light: u32

The transient message’s text in the light scheme, as ARGB; 0 keeps the design system’s.

§toast_content_dark: u32

The transient message’s text in the dark scheme, as ARGB; 0 keeps the design system’s.

§toast_border_width: Option<u16>

The width of the line around the transient message in dp. None keeps the design system’s line, and Some(0) draws none.

§toast_padding_horizontal: u16

The space left and right of the transient message’s text, in dp.

§toast_padding_vertical: u16

The space above and below the transient message’s text, in dp.

§toast_font_size: u16

The size of the transient message’s text, in sp.

§toast_line_height: u16

The line height of the transient message’s text, in sp.

Implementations§

Source§

impl OverlayTokens

Source

pub const fn new() -> Self

Source

pub const fn sheet_corner_radius(self, radius: u16) -> Self

Source

pub const fn dialog_corner_radius(self, radius: u16) -> Self

Source

pub const fn popup_corner_radius(self, radius: u16) -> Self

Source

pub const fn sheet_elevation(self, elevation: u16) -> Self

Source

pub const fn popup_elevation(self, elevation: u16) -> Self

Source

pub const fn dialog_elevation(self, elevation: u16) -> Self

Source

pub const fn sheet_padding(self, padding: u16) -> Self

Source

pub const fn dialog_padding(self, padding: u16) -> Self

Source

pub const fn popup_padding(self, padding: u16) -> Self

Source

pub const fn scrim(self, color: Color) -> Self

Source

pub const fn scrim_argb(self, argb: u32) -> Self

Source

pub const fn toast_elevation(self, elevation: u16) -> Self

The transient message’s elevation in dp: a shadow under it the height of a surface that far up. A message is not a node and takes no Modifier, so this is where its shadow is set, once for the application.

Source

pub const fn toast_corner_radius(self, radius: u16) -> Self

The transient message’s corner radius in dp.

Source

pub const fn toast_container(self, light: Color, dark: Color) -> Self

The transient message’s fill, one colour for the light scheme and one for the dark. The renderer takes the one for the scheme it is drawing in, so a message can be drawn inverted (dark on a light page, light on a dark one).

Source

pub const fn toast_content(self, light: Color, dark: Color) -> Self

The transient message’s text colour for the light scheme and for the dark.

Source

pub const fn toast_border_width(self, width: u16) -> Self

The width of the line around the transient message in dp; 0 draws none.

Source

pub const fn toast_padding(self, horizontal: u16, vertical: u16) -> Self

The space around the transient message’s text in dp: left and right, then above and below.

Source

pub const fn toast_type(self, font_size: u16, line_height: u16) -> Self

The transient message’s text size and line height in sp.

Trait Implementations§

Source§

impl Clone for OverlayTokens

Source§

fn clone(&self) -> Self

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 OverlayTokens

Source§

impl Debug for OverlayTokens

Source§

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

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

impl Default for OverlayTokens

Source§

fn default() -> Self

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

impl Eq for OverlayTokens

Source§

impl PartialEq for OverlayTokens

Source§

fn eq(&self, other: &Self) -> 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 OverlayTokens

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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