Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fornewid/placeholder
Placeholder for Jetpack Compose ⏳
https://github.com/fornewid/placeholder
accompanist android jetpack-compose
Last synced: 3 months ago
JSON representation
Placeholder for Jetpack Compose ⏳
- Host: GitHub
- URL: https://github.com/fornewid/placeholder
- Owner: fornewid
- License: apache-2.0
- Created: 2023-07-28T09:03:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T15:51:33.000Z (9 months ago)
- Last Synced: 2024-05-22T15:52:45.903Z (9 months ago)
- Topics: accompanist, android, jetpack-compose
- Language: Kotlin
- Homepage: https://fornewid.github.io/placeholder/
- Size: 2.19 MB
- Stars: 31
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Placeholder for Jetpack Compose
A library which provides a [modifier][modifier] for display 'placeholder' UI while content is loading.
The codes are copied from [accompanist][accompanist] placeholder.
If you're already using [accompanist][accompanist] placeholder, you can migrate by referring to [the migration guide](docs/migrating-from-accompanist.md).
## Compose versions
Older versionsUse accompanist/placeholder
Compose 1.5 (1.5.x)
Compose 1.6 (1.6.x)
Compose Multiplatform 1.6.10
### [Placeholder Foundation](./foundation/)
A library that provides easy-to-use modifiers for displaying a placeholder UI while content is loading.
### [Placeholder Material](./material/)
A library that provides easy-to-use modifiers for displaying a placeholder UI on Material theme.
### [Placeholder Material3](./material3/)
A library that provides easy-to-use modifiers for displaying a placeholder UI on Material3 theme.
## Usage
``` groovy
repositories {
mavenCentral()
}
dependencies {
// If you're using Material, use placeholder-material
implementation "io.github.fornewid:placeholder-material:"
// If you're using Material3, use placeholder-material3
implementation "io.github.fornewid:placeholder-material3:"
// Otherwise use the foundation version
implementation "io.github.fornewid:placeholder-foundation:"
}
```
## Snapshots
Snapshots of the current development version of Placeholder are available, which track the latest commit.
See [here](docs/using-snapshot-version.md) for more information.
## Contributions
Please contribute! We will gladly review any pull requests.
Make sure to read the [Contributing](CONTRIBUTING.md) page first though.
## License
```
Copyright 2023 fornewid
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.
```
[accompanist]: https://github.com/google/accompanist
[modifier]: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier
[migration]: https://fornewid.github.io/placeholder#migration