package toffee

  1. Overview
  2. Docs
package toffee
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Compute_grid.Explicit_gridSource

Explicit grid track initialization from CSS styles.

Implements CSS Grid auto-repeat evaluation and track instantiation. Explicit tracks are those defined in grid-template-rows/columns, including auto-fit and auto-fill repetitions. This module resolves repetition counts and builds the track list with gutters.

Sourcetype auto_repeat_strategy =
  1. | Max_repetitions_that_do_not_overflow
    (*

    Use with definite or max size constraints. Returns the largest repetition count that does not overflow the container.

    *)
  2. | Min_repetitions_that_do_overflow
    (*

    Use with min size constraints. Returns the smallest repetition count that satisfies the minimum.

    *)

Auto-repeat fit strategy for computing repetition counts.

Determines whether to maximize fit without overflow (for definite/max sizes) or minimize fit with overflow (for min sizes).

Sourceval compute_explicit_grid_size_in_axis : style:Style.t -> auto_fit_container_size:float option -> auto_fit_strategy:auto_repeat_strategy -> resolve_calc_value:Style.calc_resolver -> axis:Geometry.absolute_axis -> int * int

compute_explicit_grid_size_in_axis style auto_fit_container_size auto_fit_strategy resolve_calc_value axis computes explicit grid track counts.

Returns (num_auto_repetitions, total_explicit_track_count) where the first element is the number of auto-fit/auto-fill repetitions resolved (0 if none) and the second is the total number of explicit tracks.

Algorithm validates the template, then:

  1. If no auto-repeat: count tracks from single definitions and fixed-count repetitions.
  2. If auto-repeat present: compute repetitions based on container size, gap, and non-repeating track space.
  3. Return (0, 0) if template is invalid (multiple auto-repeats, empty repetitions, or auto-repeat with non-fixed-size tracks).

The repetition count is clamped to at least 1 if the first repetition overflows.

Invariant: At most one auto-repeat definition per axis is valid.

Sourceval initialize_grid_tracks : tracks:Compute_grid__.Grid_track.t list Stdlib.ref -> counts:Grid_track_counts.t -> style:Style.t -> axis:Geometry.absolute_axis -> track_has_items:(int -> bool) -> unit

initialize_grid_tracks tracks counts style axis track_has_items populates tracks with grid tracks and gutters.

Clears tracks and rebuilds it with:

  1. Initial gutter (collapsed).
  2. Negative implicit tracks (from grid-auto-rows/columns, cycling if needed).
  3. Explicit tracks (from grid-template-rows/columns, expanding repetitions).
  4. Positive implicit tracks.
  5. Final gutter (collapsed).

Auto-fit tracks without items are collapsed. Gutters are sized per gap style. All tracks alternate with gutters in the output list.

Precondition: counts must match the actual track counts computed for the grid.