Skip to content

A small library to display expandable texts in Jetpack Compose.

License

Notifications You must be signed in to change notification settings

dokar3/ExpandableText

Repository files navigation

ExpandableText

Maven Central

Expandable text, similar to Text() in Jetpack Compose.

Sample screen:

Screen gif

Usage

Add the dependency Maven Central :

implementation 'io.github.dokar3:expandabletext:latest_version'

Show some texts:

val text = "Your long text ".repeat(10)
var expanded by remember { mutableStateOf(false) }
ExpandableText(
    expanded = expanded,
    text = text,
    collapsedMaxLines = 2,
    modifier = Modifier
        .animateContentSize()
        .clickable { expanded = !expanded },
    toggle = { Text(text = if (expanded) "Show less" else "Show more") },
)

Known problems

  • toggle will not be visible if:
    • overflow was set to TextOverflow.Ellipsis:
      ExpandableText(
          // ...
          overflow = TextOverflow.Ellipsis,
      )
    • text is an AnnoatedString and a ParagraphStyle was applied to the line needed to show the toggle. For example:
      val text = buildAnnotatedString {
          withStyle(ParagraphStyle()) {
              append("Some long text...")
          }
      }
      ExpandableText(
        text = text,
        // ...
      )

License

Copyright 2022 dokar3

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.