Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brianwernick/annores
A Jetpack Compose library for retrieving annotated string resources
https://github.com/brianwernick/annores
Last synced: about 2 months ago
JSON representation
A Jetpack Compose library for retrieving annotated string resources
- Host: GitHub
- URL: https://github.com/brianwernick/annores
- Owner: brianwernick
- License: apache-2.0
- Created: 2023-11-24T19:53:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-25T22:24:33.000Z (6 months ago)
- Last Synced: 2024-06-26T22:36:54.462Z (6 months ago)
- Language: Kotlin
- Size: 113 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Annores
Annores, from **Anno**tated **Res**ource, provides the ability to retrieve `AnnotatedString`s from
resources through simple Composable functions.
# Why
Android `Resources` provides the ability to get a string that is formatted or a string that
is styled, however there are 2 issues with this:
1. When you get a styled string, it's a `Spanned` which isn't usable by Jetpack Compose
2. You can't get a string that is both formatted & styled
Annores addresses both of these issues by first converting the styled `Spanned` to an `AnnotatedString`
which is usable by Composables then extending this conversion to handle formatting
# Use
The latest version can be included from [Maven Central][Maven Central].
```gradle
repositories {
mavenCentral()
}
dependencies {
//...
implementation 'com.devbrackets.android:annores:1.0.1'
}
```
# Quick Start
Annotated strings should be added to your `strings.xml` files the same way you add any other string
or plural resource, e.g.
```xml
Annotated strings can be Bold, Italic, or any custom annotation
```
Then you can reference this in a Composable function via `annotatedStringResource` or
`annotatedPluralStringResource`, e.g.
```kotlin
@Composable
fun AnAnnotatedComposable() {
Text(
text = annotatedStringResource(R.string.an_annotated_string)
)
}
```
# License
Copyright 2024 Brian Wernick
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
http://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.
# Attribution
* Uses [Kotlin][Kotlin] licensed under [Apache 2.0][Apache 2.0]
* Uses [Compose][Compose] licensed under [Apache 2.0][Apache 2.0]
[Kotlin]: https://kotlinlang.org/
[Compose]: https://developer.android.com/jetpack/compose
[Maven Central]: https://search.maven.org/artifact/com.devbrackets.android/annores
[Apache 2.0]: https://opensource.org/licenses/Apache-2.0