Code Monkey home page Code Monkey logo

compose-shared-elements's Introduction

Shared Elements Transition for Jetpack Compose

Originated from mobnetic/compose-shared-element.

Shared elements transition implementation for compose with various customization options. Currently providing the following transition patterns:

Shared Elements Material Container Transform

Download

While this library is highly experimental, if you want to use it, snapshot versions are available at Sonatype OSSRH's snapshot repository. These are updated on every commit to main. To use it:

repositories {
    // ...
    maven("https://s01.oss.sonatype.org/content/repositories/snapshots")  // build.gradle.kts
    maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots' }  // build.gradle
}

dependencies {
    implementation("com.mxalbert.sharedelements:shared-elements:0.1.0-SNAPSHOT")
}

How to use

  1. Define elements with the same key and different screenKeys using SharedElement or SharedMaterialContainer composables.
  2. Wrap different screens in a single SharedElementRoot.

Transition will start when elements with the same key are detected.

Notes

  • SharedElementsTransitionSpec of the start element will be used.
  • Transition is only applied to the shared elements, so you have to define the transition for the rest yourself. See the demo for examples. If you want to prevent an element from showing in your self-defined transition, call prepareTransition(key).
  • Elements are composed separately in an overlay during transition, so remember won't work as expected. If your element is stateful, define the state outside the SharedElement or SharedMaterialContainer composables.
  • If the element is root element (i.e. direct child of SharedElementRoot) and is full-screen (e.g. has Modifier.fillMaxSize()), specifying isFullscreen = true on it can greatly improve performance and allows you to use stateful composables.

compose-shared-elements's People

Contributors

mxalbert1996 avatar volkansahin45 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.