Documentation
¶
Index ¶
- Variables
- func DerivedStateOf[T any](calculation func() T) *state.DerivedState[T]
- func DerivedStateWithPolicy[T any](calculation func() T, policy state.MutationPolicy[T]) *state.DerivedState[T]
- func MustRemember[T any](c state.SupportState, key string, initial func() T, ...) state.MutableValueTyped[T]
- func MustState[T any](c state.SupportState, key string, initial func() T, ...) state.MutableValueTyped[T]
- func Remember[T any](c state.SupportState, key string, initial func() T, ...) (state.MutableValueTyped[T], error)
- func State[T any](c state.SupportState, key string, initial func() T, ...) (state.MutableValueTyped[T], error)
- type Composable
- type Composer
- type CompositionLocal
Constants ¶
This section is empty.
Variables ¶
var LocalContentColor = CompositionLocalOf(func() graphics.Color { return graphics.ColorBlack })
LocalContentColor is a CompositionLocal containing the preferred content color for a given position in the hierarchy. This typically represents the "on" color for a color in ColorScheme. For example, if the background color is ColorScheme.surface, this color is typically set to ColorScheme.onSurface.
This color should be used for any typography / iconography, to ensure that the color of these adjusts when the background color changes. For example, on a dark background, text should be light, and on a light background, text should be dark.
Defaults to Color.Black if no color has been explicitly set.
var LocalDensity = CompositionLocalOf(func() unit.Density { panic("No Density provided") })
var LocalTextShaper = CompositionLocalOf(func() *text.TextShaper { shaper := gioText.NewShaper(gioText.NoSystemFonts(), gioText.WithCollection(fonts.Collection())) return &text.TextShaper{Shaper: shaper} })
var LocalTextStyle = CompositionLocalOf(func() *text.TextStyle { return text.TextStyleUnspecified })
var Sequence = sequence.Sequence
Use This Sequence When not inside of a composable but composing composables
Functions ¶
func DerivedStateOf ¶ added in v0.1.73
func DerivedStateOf[T any](calculation func() T) *state.DerivedState[T]
func DerivedStateWithPolicy ¶ added in v0.1.73
func DerivedStateWithPolicy[T any](calculation func() T, policy state.MutationPolicy[T]) *state.DerivedState[T]
func MustRemember ¶ added in v0.1.73
func MustRemember[T any](c state.SupportState, key string, initial func() T, options ...state.StateTypedOption[T]) state.MutableValueTyped[T]
local alias for state.MustState
func MustState ¶ added in v0.1.73
func MustState[T any](c state.SupportState, key string, initial func() T, options ...state.StateTypedOption[T]) state.MutableValueTyped[T]
local alias for state.MustState Deprecated: use MustRemember instead
func Remember ¶ added in v0.1.73
func Remember[T any](c state.SupportState, key string, initial func() T, options ...state.StateTypedOption[T]) (state.MutableValueTyped[T], error)
local alias for state.State
func State ¶ added in v0.1.73
func State[T any](c state.SupportState, key string, initial func() T, options ...state.StateTypedOption[T]) (state.MutableValueTyped[T], error)
local alias for state.State Deprecated: use Remember instead
Types ¶
type Composable ¶
type Composable = api.Composable
func CompositionLocalProvider ¶
func CompositionLocalProvider(values []api.ProvidedValue, content Composable) Composable
CompositionLocalProvider scopes the provided values to the content composable.
func CompositionLocalProvider1 ¶
func CompositionLocalProvider1[T any](local *CompositionLocal[T], value T, content Composable) Composable
Helper for single value provision
type Composer ¶
func NewComposer ¶
func NewComposer(options ...api.ComposerOption) Composer
type CompositionLocal ¶
type CompositionLocal[T any] struct { // contains filtered or unexported fields }
CompositionLocal allows passing data implicitly down the composition tree.
func CompositionLocalOf ¶
func CompositionLocalOf[T any](defaultValueFactory func() T) *CompositionLocal[T]
CompositionLocalOf creates a new CompositionLocal with a default value factory.
func StaticCompositionLocalOf ¶
func StaticCompositionLocalOf[T any](defaultValueFactory func() T) *CompositionLocal[T]
StaticCompositionLocalOf creates a CompositionLocal where the value is unlikely to change. For now, this behaves the same as CompositionLocalOf.
func (*CompositionLocal[T]) Current ¶
func (local *CompositionLocal[T]) Current(c api.Composer) T
Current returns the current value of the CompositionLocal from the Composer.
func (*CompositionLocal[T]) Provides ¶
func (local *CompositionLocal[T]) Provides(value T) api.ProvidedValue
Provides creates a ProvidedValue for this CompositionLocal.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
next/text/input
Package input provides text field state management and editing infrastructure.
|
Package input provides text field state management and editing infrastructure. |
|
next/text/input/internal
Package internal provides internal implementation details for text input.
|
Package internal provides internal implementation details for text input. |
|
next/text/input/internal/selection
Package selection provides selection state management for text fields.
|
Package selection provides selection state management for text fields. |
|
next/text/input/internal/undo
Package undo provides undo/redo infrastructure for text editing.
|
Package undo provides undo/redo infrastructure for text editing. |
|
next/text/modifiers
Package modifiers provides text modifier implementations for foundation text components.
|
Package modifiers provides text modifier implementations for foundation text components. |
|
next/text/selection
Package selection provides text selection functionality for Compose Foundation.
|
Package selection provides text selection functionality for Compose Foundation. |
|
appbar
Package appbar contains Material 3 Top App Bar components.
|
Package appbar contains Material 3 Top App Bar components. |
|
badge
Package badge contains Material 3 Badge components.
|
Package badge contains Material 3 Badge components. |
|
bottomappbar
Package bottomappbar contains Material 3 Bottom App Bar components.
|
Package bottomappbar contains Material 3 Bottom App Bar components. |
|
bottomsheet
Package bottomsheet contains Material 3 Bottom Sheet components.
|
Package bottomsheet contains Material 3 Bottom Sheet components. |
|
button
Package button contains Material 3 Button components.
|
Package button contains Material 3 Button components. |
|
card
Package card contains Material 3 Card components.
|
Package card contains Material 3 Card components. |
|
checkbox
Package checkbox contains Material 3 Checkbox components.
|
Package checkbox contains Material 3 Checkbox components. |
|
chip
Package chip contains Material 3 Chip components.
|
Package chip contains Material 3 Chip components. |
|
dialog
Package dialog contains Material 3 Dialog components.
|
Package dialog contains Material 3 Dialog components. |
|
divider
Package divider contains Material 3 Divider components.
|
Package divider contains Material 3 Divider components. |
|
floatingactionbutton
Package floatingactionbutton contains Material 3 Floating Action Button components.
|
Package floatingactionbutton contains Material 3 Floating Action Button components. |
|
iconbutton
Package iconbutton contains Material 3 Icon Button components.
|
Package iconbutton contains Material 3 Icon Button components. |
|
menu
Package menu contains Material 3 Menu components.
|
Package menu contains Material 3 Menu components. |
|
navigationbar
Package navigationbar contains Material 3 Navigation Bar components.
|
Package navigationbar contains Material 3 Navigation Bar components. |
|
navigationdrawer
Package navigationdrawer contains Material 3 Navigation Drawer components.
|
Package navigationdrawer contains Material 3 Navigation Drawer components. |
|
navigationrail
Package navigationrail contains Material 3 Navigation Rail components.
|
Package navigationrail contains Material 3 Navigation Rail components. |
|
next/textfield
Package textfield contains Material 3 Text Field components.
|
Package textfield contains Material 3 Text Field components. |
|
progress
Package progress contains Material 3 Progress Indicators components.
|
Package progress contains Material 3 Progress Indicators components. |
|
radiobutton
Package radiobutton contains Material 3 Radio Button components.
|
Package radiobutton contains Material 3 Radio Button components. |
|
scaffold
Package scaffold contains Material 3 Scaffold components.
|
Package scaffold contains Material 3 Scaffold components. |
|
segmentedbutton
Package segmentedbutton contains Material 3 Segmented Button components.
|
Package segmentedbutton contains Material 3 Segmented Button components. |
|
slider
Package slider contains Material 3 Slider components.
|
Package slider contains Material 3 Slider components. |
|
snackbar
Package snackbar contains Material 3 Snackbar components.
|
Package snackbar contains Material 3 Snackbar components. |
|
surface
Package surface contains Material 3 Surface components.
|
Package surface contains Material 3 Surface components. |
|
switch
Package switch contains Material 3 Switch components.
|
Package switch contains Material 3 Switch components. |
|
tab
Package tab contains Material 3 Tab components.
|
Package tab contains Material 3 Tab components. |
|
text
Package text contains Material 3 Text components and typography.
|
Package text contains Material 3 Text components and typography. |
|
textfield
Package textfield contains Material 3 Text Field components.
|
Package textfield contains Material 3 Text Field components. |
|
tooltip
Package tooltip contains Material 3 Tooltip components.
|
Package tooltip contains Material 3 Tooltip components. |
|
graphics
Package graphics provides UI graphics primitives.
|
Package graphics provides UI graphics primitives. |
|
next/text
Package text provides rich text styling and annotation capabilities.
|
Package text provides rich text styling and annotation capabilities. |