Skip to content

Compose Multiplatform icon which have 3 states (burger, arrow and cross) and animated transitions between them

Notifications You must be signed in to change notification settings

zTrap/navigation-toggle-icon

Repository files navigation

Navigation toggle icon

Compose Multiplatform icon which have 3 states (burger, arrow and cross) and animated transitions between them

GitHub license Download

Supported platforms: badge badge badge badge

Install

implementation 'ru.ztrap:navigation-toggle-icon:${latestVersion}'

Sample

sample

Usage

  1. Simple toggle icon

    var toggled by remember { mutableStateOf(false) }
    
    NavigationToggleIcon(
        modifier = Modifier.size(24.dp).clickable { toggled = !toggled },
        startIconType = Burger,
        endIconType = Arrow,
        toggled = toggled,
        contentDescription = null,
    )
  2. Toggle icon with controlled progress

    val progress = // any source which produce progress in 0f..1f bounds
    
    NavigationToggleIcon(
        modifier = Modifier.size(24.dp),
        startIconType = Burger,
        endIconType = Arrow,
        progress = progress,
        contentDescription = null,
    )

Developed By

License

Copyright 2024 Peter Gulko (zTrap)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.