Remove all references to Snapper (#7)

chrisbanes · Oct 29, 2023 · 0185feb · 0185feb
1 parent 1d01706
commit 0185feb
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 201 deletions.
diff --git a/.gitignore b/.gitignore
@@ -43,6 +43,9 @@ org.eclipse.buildship.core.prefs
 .project
 bin/
 
+# Docs
+site/
+
 
 ##########################################################################################
 # Imported from https://github.com/github/gitignore/blob/main/Swift.gitignore

diff --git a/README.md b/README.md
@@ -2,16 +2,6 @@
 
 ## Haze
 
-Snapper is now deprecated, due to it's functionality being replaced by [`SnapFlingBehavior`](https://developer.android.com/reference/kotlin/androidx/compose/foundation/gestures/snapping/SnapFlingBehavior) which is available in Jetpack Compose 1.3.0.
-
-The `SnapFlingBehavior` API is very similar to Snapper, so migration should be very easy. I haven't provided an automatic migration path, as I feel that it's important to learn the new API by performing the migration yourself.
-
-## Library
-
-![](docs/assets/header.png)
-
-Snapper is a library which brings snapping to the Compose scrolling layouts (currently only LazyColumn and LazyRow).
-
 Check out the website for more information: https://chrisbanes.github.io/haze
 
 ## License

diff --git a/docs/assets/croc.svg b/docs/assets/croc.svg
diff --git a/docs/assets/demo.mp4 b/docs/assets/demo.mp4
diff --git a/docs/assets/header.png b/docs/assets/header.png
diff --git a/docs/assets/tivi.mp4 b/docs/assets/tivi.mp4
diff --git a/docs/index.md b/docs/index.md
@@ -1,60 +1,9 @@
-[![Maven Central](https://img.shields.io/maven-central/v/dev.chrisbanes.haze/snapper)](https://search.maven.org/search?q=g:dev.chrisbanes.haze)
+[![Maven Central](https://img.shields.io/maven-central/v/dev.chrisbanes.haze/haze)](https://search.maven.org/search?q=g:dev.chrisbanes.haze)
 
-![](assets/header.png)
-
-## Deprecated
-
-Snapper is now deprecated, due to it's functionality being replaced by [`SnapFlingBehavior`](https://developer.android.com/reference/kotlin/androidx/compose/foundation/gestures/snapping/SnapFlingBehavior) in Jetpack Compose 1.3.0.
-
-The `SnapFlingBehavior` API is very similar to Snapper, so migration should be very easy. I haven't provided an automatic migration path, as I feel that it's important to learn the new API by performing the migration yourself.
-
-## Library
-
-Snapper is a library which brings snapping to the Compose scrolling layouts (currently LazyColumn and LazyRow):
-
-=== "Sample app"
-
-    <video width="100%" controls loop style="max-width: 600px">
-        <source src="assets/demo.mp4" type="video/mp4">
-        Your browser does not support the video tag.
-    </video>
-
-
-=== "Tivi"
-
-    <video width="100%" controls loop style="max-width: 600px">
-        <source src="assets/tivi.mp4" type="video/mp4">
-        Your browser does not support the video tag.
-    </video>
-
-
-The basic usage looks like so:
-
-``` kotlin
-val lazyListState = rememberLazyListState()
-
-LazyRow(
-    state = lazyListState,
-    flingBehavior = rememberSnapperFlingBehavior(lazyListState),
-) {
-    // content
-}
-```
-
-## API Summary
-
-The API is generally split into a few things:
-
-- [SnapperFlingBehavior](api/lib/dev.chrisbanes.haze/-snapper-layout-info/), which is what apps provide to scrollable containers.
-- A number of [remember functions](api/lib/dev.chrisbanes.haze/remember-snapper-fling-behavior.html) allowing easy use of `SnapperFlingBehavior` from composables.
-- [SnapperFlingLayoutInfo](api/lib/dev.chrisbanes.haze/-snapper-layout-info/), which is an facade class allowing `SnapperFlingBehavior` to interact with different scrollable container state in a generic way.
-- Implementations of `SnapperFlingLayoutInfo` for easy integration, such as [LazyListFlingLayoutInfo](api/lib/dev.chrisbanes.haze/-lazy-list-snapper-layout-info/).
-
-For examples, refer to the [samples](https://github.com/chrisbanes/snapper/tree/main/sample/src/main/java/dev/chrisbanes/snapper/sample).
 
 ## Download
 
-[![Maven Central](https://img.shields.io/maven-central/v/dev.chrisbanes.haze/snapper)](https://search.maven.org/search?q=g:dev.chrisbanes.haze)
+[![Maven Central](https://img.shields.io/maven-central/v/dev.chrisbanes.haze/haze)](https://search.maven.org/search?q=g:dev.chrisbanes.haze)
 
 ```groovy
 repositories {

diff --git a/docs/usage.md b/docs/usage.md
diff --git a/docs/using-snapshot-version.md b/docs/using-snapshot-version.md
@@ -1,7 +1,6 @@
 # Using a Snapshot Version of the Library
 
-If you would like to depend on the cutting edge version of the Snapper
-library, you can use the [snapshot versions][snap] that are published to
+If you would like to depend on the cutting edge version of the library, you can use the [snapshot versions][snap] that are published to
 [Sonatype OSSRH](https://central.sonatype.org/)'s snapshot repository. These are updated on every commit to `main`.
 
 To do so:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -14,8 +14,7 @@ repo_url: 'https://github.com/chrisbanes/haze'
 # Navigation
 nav:
   - 'Overview': index.md
-  - 'Usage': usage.md
-  - 'API reference': api/lib/dev.chrisbanes.haze/
+  - 'API reference': api/
   - 'Sample code': https://github.com/chrisbanes/haze/tree/main/sample/shared/src/commonMain/kotlin/dev/chrisbanes/haze/sample
 
 # Configuration
@@ -24,11 +23,11 @@ theme:
   language: 'en'
   logo: assets/croc.svg
   palette:
-    primary: 'teal'
+    primary: 'white'
     accent: 'teal'
   font:
-    text: 'Roboto'
-    code: 'JetBrains Mono'
+    text: 'DM Sans'
+    code: 'Space Mono'
 
 # Extensions
 markdown_extensions: