Struct MaxTrackSizingFunction

pub struct MaxTrackSizingFunction(/* private fields */);

Expand description

Maximum track sizing function

Specifies the maximum size of a grid track. A grid track will automatically size between it’s minimum and maximum size based on the size of it’s contents, the amount of available space, and the sizing constraint the grid is being size under. See https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns

Implementations§

§

impl MaxTrackSizingFunction

pub const fn length(val: f32) -> MaxTrackSizingFunction

An absolute length in some abstract units. Users of Taffy may define what they correspond to in their application (pixels, logical pixels, mm, etc) as they see fit.

pub const fn percent(val: f32) -> MaxTrackSizingFunction

A percentage length relative to the size of the containing block.

NOTE: percentages are represented as a f32 value in the range [0.0, 1.0] NOT the range [0.0, 100.0]

pub const fn auto() -> MaxTrackSizingFunction

The dimension should be automatically computed according to algorithm-specific rules regarding the default size of boxes.

pub const fn min_content() -> MaxTrackSizingFunction

The size should be the “min-content” size. This is the smallest size that can fit the item’s contents with ALL soft line-wrapping opportunities taken

pub const fn max_content() -> MaxTrackSizingFunction

The size should be the “max-content” size. This is the smallest size that can fit the item’s contents with NO soft line-wrapping opportunities taken

pub const fn fit_content_px(limit: f32) -> MaxTrackSizingFunction

The size should be computed according to the “fit content” formula: max(min_content, min(max_content, limit)) where:

min_content is the min-content size
max_content is the max-content size
limit is a LENGTH value passed to this function

The effect of this is that the item takes the size of limit clamped by the min-content and max-content sizes.

pub const fn fit_content_percent(limit: f32) -> MaxTrackSizingFunction

The size should be computed according to the “fit content” formula: max(min_content, min(max_content, limit)) where:

min_content is the min-content size
max_content is the max-content size
limit is a PERCENTAGE value passed to this function

The effect of this is that the item takes the size of limit clamped by the min-content and max-content sizes.

pub const fn fr(val: f32) -> MaxTrackSizingFunction

The dimension as a fraction of the total available grid space (fr units in CSS) Specified value is the numerator of the fraction. Denominator is the sum of all fraction specified in that grid dimension Spec: https://www.w3.org/TR/css3-grid-layout/#fr-unit

pub fn calc(ptr: *const ()) -> MaxTrackSizingFunction

A calc() value. The value passed here is treated as an opaque handle to the actual calc representation and may be a pointer, index, etc.

The low 3 bits are used as a tag value and will be returned as 0.

pub unsafe fn from_raw(val: CompactLength) -> MaxTrackSizingFunction

Create a LengthPercentageAuto from a raw CompactLength.

§Safety

CompactLength must represent a valid variant for LengthPercentageAuto

pub fn into_raw(self) -> CompactLength

Get the underlying CompactLength representation of the value

pub fn is_intrinsic(&self) -> bool

Returns true if the max track sizing function is MinContent, MaxContent, FitContent or Auto, else false.

pub fn is_max_content_alike(&self) -> bool

Returns true if the max track sizing function is MaxContent, FitContent or Auto else false. “In all cases, treat auto and fit-content() as max-content, except where specified otherwise for fit-content().” See: https://www.w3.org/TR/css-grid-1/#algo-terms

pub fn is_fr(&self) -> bool

Returns true if the an Fr value, else false.

pub fn is_auto(&self) -> bool

Returns true if the is Auto, else false.

pub fn is_min_content(&self) -> bool

Returns true if value is MinContent

pub fn is_max_content(&self) -> bool

Returns true if value is MaxContent

pub fn is_fit_content(&self) -> bool

Returns true if value is FitContent(…)

pub fn is_max_or_fit_content(&self) -> bool

Returns true if value is MaxContent or FitContent(…)

pub fn has_definite_value(self, parent_size: Option<f32>) -> bool

Returns whether the value can be resolved using Self::definite_value

pub fn definite_value( self, parent_size: Option<f32>, calc_resolver: impl Fn(*const (), f32) -> f32, ) -> Option<f32>

Returns fixed point values directly. Attempts to resolve percentage values against the passed available_space and returns if this results in a concrete value (which it will if the available_space is Some). Otherwise returns None.

pub fn definite_limit( self, parent_size: Option<f32>, calc_resolver: impl Fn(*const (), f32) -> f32, ) -> Option<f32>

Resolve the maximum size of the track as defined by either: - A fixed track sizing function - A percentage track sizing function (with definite available space) - A fit-content sizing function with fixed argument - A fit-content sizing function with percentage argument (with definite available space) All other kinds of track sizing function return None.