compose/com.gonodono.hexgrid.compose

Package-level declarations

Types

Link copied to clipboard
@Immutable
data class HexGridColors

The cell stroke and fill colors used by HexGrid.

Link copied to clipboard
object HexGridDefaults

Default values used by HexGrid.

Link copied to clipboard
interface HexGridItemScope

Child Composable scope for HexGrid.

Link copied to clipboard
@Immutable
class ImmutableGrid : Grid

The immutable version of Grid.

Link copied to clipboard
@Immutable
data class IndicesShown

Flags for which indices are shown in each cell.

Functions

Link copied to clipboard
Link copied to clipboard
@Composable
fun HexGrid(grid: ImmutableGrid, modifier: Modifier = Modifier, fitMode: FitMode = FitMode.FitColumns, crossMode: CrossMode = CrossMode.AlignCenter, hexOrientation: HexOrientation = HexOrientation.Horizontal, strokeWidth: Dp = Dp.Hairline, colors: HexGridColors = HexGridDefaults.colors(), indicesShown: IndicesShown = HexGridDefaults.indicesShown(), clipToBounds: Boolean = true, onGridTap: (Grid.Address) -> Unit? = null, onOutsideTap: () -> Unit? = null, cellItems: @Composable HexGridItemScope.(Grid.Address) -> Unit? = null)

The Compose version of the library's hex grid.

Link copied to clipboard
fun MutableGrid.toImmutable(): ImmutableGrid

Copies this MutableGrid and wraps the new instance in an ImmutableGrid.