Package-level declarations

Types

Link copied to clipboard
interface Property
Link copied to clipboard

A stable class that manages the state and properties of various sticky items (e.g., Post-it notes, images, text boxes). It allows updating properties such as size, background color, text style, and more.

Link copied to clipboard

A stable interface that defines touch event behaviors for sticky items. The interface includes methods to handle touch events like initialization, start, move, and end.

Link copied to clipboard

Enum class that represents different types of sticky items. Each sticky item can have one of the following types, each corresponding to a specific kind of sticky element.

Functions

Link copied to clipboard
fun rememberStickyItemController(postItProperty: PostItProperty = PostItProperty.DEFAULT, painterImageProperty: PainterImageProperty = PainterImageProperty.DEFAULT, vectorImageProperty: VectorImageProperty = VectorImageProperty.DEFAULT, bitmapImageProperty: ImageBitmapProperty = ImageBitmapProperty.DEFAULT, textBoxProperty: TextBoxProperty = TextBoxProperty.DEFAULT): StickyItemController

A Composable function to create and remember an instance of StickyItemController. This controller manages various properties for sticky items, such as Post-its, images, and text boxes. It provides the ability to update the properties and manage the state of each sticky item.

Link copied to clipboard
fun Sticky(modifier: Modifier = Modifier, attachable: Attachable, stickySize: DpSize, onStickyMoved: (Offset) -> Unit, onZoomChanged: (Float, Offset) -> Unit, content: @Composable () -> Unit = {})

A Composable that displays a sticky item which can be moved and zoomed using gestures. This composable supports both dragging (panning) and pinch-to-zoom gestures.

Link copied to clipboard
fun StickyNote(modifier: Modifier = Modifier, controller: StickyItemController)

A composable function that displays a collection of sticky notes (such as text, images, etc.) and allows for interactions like moving, zooming, and editing them.

Link copied to clipboard
fun Modifier.useStickyMode(controller: StickyItemController, isEnabled: Boolean = true): Modifier

A custom modifier function that enables "sticky mode" for a given view or composable. Sticky mode allows interactive gestures such as touch events to be handled by the StickyItemController.