From 2cb6c284c2de565d12c7cc057dfd63cd7103cac5 Mon Sep 17 00:00:00 2001 From: Sungyong An Date: Fri, 7 Jun 2024 01:12:43 +0900 Subject: [PATCH] Update .md --- README.md | 4 +-- docs/core.md | 2 +- docs/navigation.md | 73 ---------------------------------------------- mkdocs.yml | 11 +++---- 4 files changed, 7 insertions(+), 83 deletions(-) delete mode 100644 docs/navigation.md diff --git a/README.md b/README.md index f57a237f..703151fa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ logo -# Material Motion for Jetpack Compose +# Material Motion for Jetpack Compose and Compose Multiplatform @@ -9,7 +9,7 @@ -Jetpack Compose library for implementing [motion system](https://material.io/develop/android/theming/motion/) in Material Components for Android and Compose Multiplatform. +A library for implementing [motion system](https://material.io/develop/android/theming/motion/) in Material Components for Jetpack Compose and Compose Multiplatform. ## Compose versions diff --git a/docs/core.md b/docs/core.md index 8bdf6d84..4ee100e2 100644 --- a/docs/core.md +++ b/docs/core.md @@ -2,7 +2,7 @@ [![Maven Central](https://img.shields.io/maven-central/v/io.github.fornewid/material-motion-compose-core)](https://search.maven.org/search?q=g:io.github.fornewid) -Material Motion Core is a Jetpack Compose library for implementing [motion system](https://material.io/develop/android/theming/motion/) in Material Components for Android. +Material Motion Core is a library for implementing [motion system](https://material.io/develop/android/theming/motion/) in Material Components for Jetpack Compose and Compose Multiplatform. ## Usage diff --git a/docs/navigation.md b/docs/navigation.md deleted file mode 100644 index b64ac8af..00000000 --- a/docs/navigation.md +++ /dev/null @@ -1,73 +0,0 @@ -# Material Motion Navigation - -[![Maven Central](https://img.shields.io/maven-central/v/io.github.fornewid/material-motion-compose-navigation)](https://search.maven.org/search?q=g:io.github.fornewid) - -## Usage - -```kotlin -val navController = rememberMaterialMotionNavController() - -MaterialMotionNavHost(navController, startDestination = "first") { - composable("first", - enterMotionSpec = { holdIn() }, - exitMotionSpec = { holdOut() }, - ) { - // first composable - } - - composable("second", - enterMotionSpec = { materialSharedAxisXIn() }, - exitMotionSpec = { materialSharedAxisXOut() }, - ) { - // second composable - } -} -``` - -## Migration - -### From 'accompanist-navigation-animation' library - -The migration is simple. - -Please check differences in the following codes. - -```diff -- import com.google.accompanist.navigation.animation.AnimatedNavHost -- import com.google.accompanist.navigation.animation.composable -- import com.google.accompanist.navigation.animation.navigation -- import com.google.accompanist.navigation.animation.rememberAnimatedNavController -+ import soup.compose.material.motion.navigation.MaterialMotionNavHost -+ import soup.compose.material.motion.navigation.composable -+ import soup.compose.material.motion.navigation.navigation -+ import soup.compose.material.motion.navigation.rememberMaterialMotionNavController - -- val navController = rememberAnimatedNavController() -+ val navController = rememberMaterialMotionNavController() -- AnimatedNavHost( -+ MaterialMotionNavHost( - ..., - ) { - composable(...) { ... } - navigation(...) { - composable(...) { ... } - } - } -``` - -## Download - -[![Maven Central](https://img.shields.io/maven-central/v/io.github.fornewid/material-motion-compose-navigation)](https://search.maven.org/search?q=g:io.github.fornewid) - -```gradle -repositories { - mavenCentral() -} - -dependencies { - implementation "io.github.fornewid:material-motion-compose-navigation:" - - // If you want to change motion, use with core library. - implementation "io.github.fornewid:material-motion-compose-core:" -} -``` diff --git a/mkdocs.yml b/mkdocs.yml index dacfaa42..e331b8a9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ -site_name: "Material Motion for Jetpack Compose" -site_description: "A library that provides components supporting material motion patterns for Jetpack Compose." +site_name: "Material Motion for Jetpack Compose and Compose Multiplatform" +site_description: "A library that provides components supporting material motion patterns for Jetpack Compose and Compose Multiplatform." site_author: "fornewid" remote_branch: gh-pages @@ -10,11 +10,8 @@ repo_url: https://github.com/fornewid/material-motion-compose # Navigation nav: - "Overview": index.md - - "Core": - - 'Guide': core.md - - 'API': api/core/ - - "Navigation": - - 'Guide': navigation.md + - "Guide": core.md + - "API": api/core/ - "Migration": - '0.5 to 0.6': migrating-from-0.5-to-0.6.md - '0.9 to 0.10': migrating-from-0.9-to-0.10.md