Enum SurfaceRole 

pub enum SurfaceRole {
    None,
    Panel,
    Raised,
    Sunken,
    Popover,
    Selected,
    Current,
    Input,
    Danger,
}

Semantic paint role for rect-shaped surfaces.

Each variant maps to a theme-applied recipe at paint time. Roles are either decorative (set stroke + shadow on top of whatever fill the node already carries) or fill-providing (default a fill from the palette when the node has none). The split matters: setting a decorative role on a node with no fill produces an “invisible surface” — only a thin border over the parent’s background. For panel-shaped containers, prefer the dedicated widget (card(), sidebar(), dialog(), popover()) which bundles role + fill + stroke + radius + shadow correctly.

Variants

None

No special semantic role. Theme fallback applies.

Panel

Decorative. Border + small drop shadow. Does not paint a fill — the node must supply one (e.g. tokens::CARD) or sit inside a widget like card() / sidebar() that does.

Raised

Decorative. Border + half-strength shadow, suggesting one elevation step above its parent. Like Panel, no fill.

Sunken

Fill-providing. Slightly darker variant of MUTED (palette darken(0.08)) with input-toned border. Use for inset bands — search wells, segmented-control tracks, recessed list headers.

Popover

Decorative. Input-toned border + large drop shadow for floating panels. Used by popover() and friends; bring your own fill (typically tokens::POPOVER).

Selected

Fill-providing. PRIMARY-tinted alpha 28 fill + PRIMARY-tinted alpha 110 border. The selected item inside a collection. Prefer the .selected() chainable, which sets this role plus content color in one call.

Current

Fill-providing. Solid ACCENT fill + neutral border for the current page / nav item. Prefer the .current() chainable, which also bumps font weight and content color.

Input

Fill-providing. Same recipe as Sunken — used by text inputs and other editable surfaces.

Danger

Decorative. Destructive-toned border, no shadow. Pair with a tint fill (e.g. tokens::DESTRUCTIVE.with_alpha(40)) for the classic “danger” band in a form or section header.

Implementations

impl SurfaceRole

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

pub fn uniform_id(self) -> f32

Trait Implementations

impl Clone for SurfaceRole

fn clone(&self) -> SurfaceRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceRole

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

Formats the value using the given formatter.

impl Default for SurfaceRole

fn default() -> SurfaceRole

Returns the “default value” for a type.

impl Hash for SurfaceRole

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SurfaceRole

fn cmp(&self, other: &SurfaceRole) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SurfaceRole

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SurfaceRole

fn partial_cmp(&self, other: &SurfaceRole) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SurfaceRole

impl Eq for SurfaceRole

impl StructuralPartialEq for SurfaceRole