Skip to main content

ScrollbarStyle

Struct ScrollbarStyle 

Source
pub struct ScrollbarStyle {
    pub thumb: Color,
    pub track: Option<Color>,
    pub width: ScrollbarWidthMode,
    pub thickness: f32,
    pub thickness_thin: f32,
    pub hover_boost: f32,
    pub hover_track: Color,
    pub min_thumb: f32,
    pub margin: f32,
    pub fade_delay_secs: f32,
    pub fade_secs: f32,
}
Expand description

Overlay-scrollbar styling for one scroll container - the runtime mirror of the standard CSS properties scrollbar-color: <thumb> [<track>] and scrollbar-width: auto | thin | none (CSS Scrollbars Styling Level 1; both transpile 1:1 to the web backend). Set from the stylesheet by lumenc; the skin defaults live in skins/default.css via the --lumen-scrollbar-* tokens.

This component’s Default is the only place fallback visuals are defined (the blank-no-css contract): when no stylesheet rule matches, both the paint extract and the interaction FSM read these values. Fields without a real-CSS spelling today (minimum thumb length, fade timings) still live here - one struct a per-OS skin layer or future custom property can override without touching the FSM or the paint code.

Fields§

§thumb: Color

Thumb fill (scrollbar-color first value).

§track: Option<Color>

Track fill (scrollbar-color second value). Some = painted whenever the bar is visible (CSS semantics); None = the fallback translucent track shown only while the bar is hovered (overlay convention).

§width: ScrollbarWidthMode

scrollbar-width keyword.

§thickness: f32

Bar thickness in logical pixels at scrollbar-width: auto (scrollbar-thickness CSS property).

§thickness_thin: f32

Bar thickness in logical pixels at scrollbar-width: thin (scrollbar-thickness-thin CSS property).

§hover_boost: f32

Thumb alpha multiplier while the bar is hovered / dragged (scrollbar-hover-boost CSS property).

§hover_track: Color

Fallback hover-only track fill used when Self::track is None (scrollbar-track-hover CSS property).

§min_thumb: f32

Minimum thumb length in logical pixels (theme minimum; scrollbar-min-thumb CSS property).

§margin: f32

Inset from the viewport edges in logical pixels (scrollbar-margin CSS property).

§fade_delay_secs: f32

Seconds of inactivity before the bars start fading out (scrollbar-fade-delay CSS property).

§fade_secs: f32

Fade-out ramp length in seconds (scrollbar-fade-duration CSS property).

Implementations§

Source§

impl ScrollbarStyle

Source

pub fn thickness(&self) -> Option<f32>

Resolved bar thickness in logical pixels; None = bars hidden (scrollbar-width: none).

Source

pub fn metrics(&self) -> Option<ScrollbarMetrics>

Geometry inputs for vertical_scrollbar / horizontal_scrollbar; None when bars are disabled.

Trait Implementations§

Source§

impl Clone for ScrollbarStyle

Source§

fn clone(&self) -> ScrollbarStyle

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 Component for ScrollbarStyle
where Self: Send + Sync + 'static,

Source§

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.
Source§

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>. Read more
Source§

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components. Read more
Source§

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component. Read more
Source§

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts. Read more
§

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this Component if one is defined.
§

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this Component if one is defined.
§

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this Component if one is defined.
§

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this Component if one is defined.
§

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this Component if one is defined.
§

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)
where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities] Read more
Source§

impl Debug for ScrollbarStyle

Source§

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

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

impl Default for ScrollbarStyle

Source§

fn default() -> Self

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

impl PartialEq for ScrollbarStyle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Copy for ScrollbarStyle

Source§

impl StructuralPartialEq for ScrollbarStyle

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
§

impl<C> Bundle for C
where C: Component,

§

fn component_ids( components: &mut ComponentsRegistrator<'_>, ) -> impl Iterator<Item = ComponentId> + use<C>

§

fn get_component_ids( components: &Components, ) -> impl Iterator<Item = Option<ComponentId>>

Return a iterator over this Bundle’s component ids. This will be None if the component has not been registered.
§

impl<C> BundleFromComponents for C
where C: Component,

§

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

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
§

impl<C> DynamicBundle for C
where C: Component,

§

type Effect = ()

An operation on the entity that happens after inserting this bundle.
§

unsafe fn get_components( ptr: MovingPtr<'_, C>, func: &mut impl FnMut(StorageType, OwningPtr<'_>), ) -> <C as DynamicBundle>::Effect

Moves the components out of the bundle. Read more
§

unsafe fn apply_effect( _ptr: MovingPtr<'_, MaybeUninit<C>>, _entity: &mut EntityWorldMut<'_>, )

Applies the after-effects of spawning this bundle. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromTemplate for T
where T: Clone + Default + Unpin,

§

type Template = T

The Template for this type.
§

impl<T> FromWorld for T
where T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using default().

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.

§

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
§

impl<T> Template for T
where T: Clone + Default + Unpin,

§

type Output = T

The type of value produced by this Template.
§

fn build_template( &self, _context: &mut TemplateContext<'_, '_>, ) -> Result<<T as Template>::Output, BevyError>

Uses this template and the given entity context to produce a Template::Output.
§

fn clone_template(&self) -> T

Clones this template. See Clone.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> ConditionalSend for T
where T: Send,