Computer >> Hướng Dẫn Máy Tính >  >> Hệ Thống >> Android

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Khi viết bài trước về Jetpack Compose, tôi đã nói rằng Compose thiếu một số thành phần cơ bản (theo ý kiến của tôi), và tooltip là một trong số đó.

Lúc đó, không có composable built-in để hiển thị tooltip và có vài giải pháp thay thế vòng quanh online. Vấn đề với những giải pháp đó là khi Jetpack Compose phát hành phiên bản mới, chúng có thể bị phá vỡ. Vì vậy không lý tưởng và cộng đồng chỉ hy vọng tương lai sẽ thêm hỗ trợ tooltip.

Tôi vui mừng thông báo rằng kể từ phiên bản 1.1.0 của Compose Material 3, chúng ta đã có hỗ trợ tooltip built-in. 👏

Mặc dù bản thân điều này tuyệt vời, nhưng đã hơn một năm kể từ khi phiên bản đó phát hành. Và với các phiên bản tiếp theo, API liên quan đến tooltip cũng thay đổi mạnh mẽ.

Nếu bạn xem changelog, bạn sẽ thấy cách API public và internal đã thay đổi. Vì vậy hãy lưu ý, khi đọc bài này, mọi thứ có thể tiếp tục thay đổi vì mọi thứ liên quan đến Tooltip vẫn được đánh dấu bằng annotation ExperimentalMaterial3Api::class.

❗️ Phiên bản Material 3 dùng cho bài này là 1.2.1, phát hành ngày 6 tháng 3 năm 2024

Giờ chúng ta có hỗ trợ hai loại tooltip khác nhau:

  1. Plain tooltip (Tooltip đơn giản)

  2. Rich media tooltip (Tooltip đa phương tiện)

Plain Tooltip

Bạn có thể dùng loại đầu tiên để cung cấp thông tin về icon button mà không rõ nghĩa. Ví dụ, dùng plain tooltip để chỉ cho người dùng icon button đại diện cho gì.

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Để thêm tooltip vào ứng dụng, bạn dùng composable TooltipBox. Composable này nhận một vài đối số:

fun TooltipBox( positionProvider: PopupPositionProvider, tooltip: @Composable TooltipScope.() -> Unit, state: TooltipState, modifier: Modifier = Modifier, focusable: Boolean = true, enableUserInput: Boolean = true, content: @Composable () -> Unit, ) 

Một số đối số bạn có thể quen nếu đã dùng Composable. Tôi sẽ làm nổi bật những cái có trường hợp dùng đặc thù:

  • positionProvider - Kiểu PopupPositionProvider, dùng để tính toán vị trí tooltip.

  • tooltip - Nơi bạn thiết kế UI tooltip sẽ trông như thế nào.

  • state - Giữ trạng thái liên kết với một instance Tooltip cụ thể. Nó expose phương thức show/dismiss tooltip và khi khởi tạo instance, bạn có thể khai báo tooltip có persistent hay không (tức là có hiển thị liên tục trên màn hình cho đến khi user click ra ngoài tooltip).

  • content - Đây là UI mà tooltip sẽ hiển thị trên/dưới.

Ví dụ khởi tạo BasicTooltipBox với tất cả đối số liên quan:

@OptIn(ExperimentalFoundationApi::class, ExperimentalMaterial3Api::class) @Composable fun BasicTooltip() { val tooltipPosition = TooltipDefaults.rememberPlainTooltipPositionProvider() val tooltipState = rememberBasicTooltipState(isPersistent = false) BasicTooltipBox(positionProvider = tooltipPosition, tooltip = { Text("Hello World") } , state = tooltipState) { IconButton(onClick = { }) { Icon(imageVector = Icons.Filled.Favorite, contentDescription = "Mô tả icon của bạn") } } } 

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Jetpack Compose có class built-in tên TooltipDefaults. Bạn có thể dùng class này để giúp khởi tạo đối số tạo nên TooltipBox. Ví dụ, bạn có thể dùng TooltipDefaults.rememberPlainTooltipPositionProvider để định vị tooltip đúng vị trí liên quan đến element neo (anchor).

Rich Tooltip

Rich media tooltip chiếm diện tích lớn hơn plain tooltip và có thể dùng để cung cấp ngữ cảnh nhiều hơn về chức năng của icon button. Khi tooltip hiển thị, bạn có thể thêm button và link vào nó để giải thích thêm hoặc định nghĩa.

Nó được khởi tạo tương tự như plain tooltip, bên trong TooltipBox, nhưng bạn dùng composable RichTooltip.

TooltipBox(positionProvider = tooltipPosition, tooltip = { RichTooltip( title = { Text("RichTooltip") }, caretSize = caretSize, action = { TextButton(onClick = { scope.launch { tooltipState.dismiss() tooltipState.onDispose() } }) { Text("Dismiss") } } ) { Text("Đây là nơi mô tả sẽ nằm.") } }, state = tooltipState) { IconButton(onClick = { /* sự kiện click icon button */ }) { Icon(imageVector = tooltipIcon, contentDescription = "Mô tả icon của bạn", tint = iconColor) } } 

Một vài điều chú ý về Rich tooltip:

  1. Rich tooltip hỗ trợ caret (mũi tên chỉ).

  2. Bạn có thể thêm action (tức là button) vào tooltip để cho user tùy chọn tìm hiểu thêm thông tin.

  3. Bạn có thể thêm logic dismiss tooltip.

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Trường hợp biên (Edge Cases)

Khi bạn chọn đánh dấu tooltip state là persistent, nghĩa là một khi user tương tác với UI hiển thị tooltip, nó sẽ ở lại hiển thị cho đến khi user nhấn bất kỳ đâu khác trên màn hình.

Nếu bạn nhìn ví dụ Rich tooltip ở trên, bạn có thể nhận thấy chúng ta thêm button dismiss tooltip khi click.

Có một vấn đề xảy ra khi user nhấn button đó. Vì hành động dismiss được thực hiện trên tooltip, nếu user muốn long press lại vào UI item gọi tooltip này, tooltip sẽ không hiển thị lại. Nghĩa là trạng thái tooltip persistent ở trạng thái dismissed. Vậy làm sao giải quyết?

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Để "reset" trạng thái tooltip, chúng ta phải gọi phương thức onDispose được expose qua tooltip state. Khi làm vậy, trạng thái tooltip được reset và tooltip sẽ hiển thị lại khi user long press vào UI item.

@OptIn(ExperimentalMaterial3Api::class) @Composable fun RichTooltip() { val tooltipPosition = TooltipDefaults.rememberRichTooltipPositionProvider() val tooltipState = rememberTooltipState(isPersistent = true) val scope = rememberCoroutineScope() TooltipBox(positionProvider = tooltipPosition, tooltip = { RichTooltip( title = { Text("RichTooltip") }, caretSize = TooltipDefaults.caretSize, action = { TextButton(onClick = { scope.launch { tooltipState.dismiss() tooltipState.onDispose() /// <---- TẠI ĐÂY } }) { Text("Dismiss") } } ) { } }, state = tooltipState) { IconButton(onClick = { }) { Icon(imageVector = Icons.Filled.Call, contentDescription = "Mô tả icon của bạn") } } } 

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Một kịch bản khác mà tooltip state không reset là nếu thay vì tự gọi dismiss theo hành động user, user click ra ngoài tooltip khiến nó dismiss. Điều này gọi dismiss method ngầm và tooltip state chuyển sang dismissed. Long press vào UI element để xem tooltip lại sẽ không có kết quả.

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Logic gọi onDispose của tooltip không được trigger, vậy làm sao reset trạng thái tooltip?

Hiện tại tôi chưa tìm ra cách. Có thể liên quan đến MutatorMutex của tooltip. Có thể với bản phát hành sau sẽ có API cho việc này. Tôi nhận thấy nếu có tooltip khác trên màn hình và chúng được nhấn, điều này sẽ reset tooltip trước đó được click.

Sử dụng Tooltip trong Jetpack Compose: Hướng dẫn từng bước

Nếu bạn muốn xem code trong bài, vào repository GitHub này

Nếu muốn xem tooltip trong ứng dụng, xem tại đây.

Tham khảo

  • Material3 Tooltip Overview

  • Tooltip Defaults

  • Tooltip Source Code

Học lập trình miễn phí. Chương trình mở của freeCodeCamp đã giúp hơn 40.000 người có việc làm developer. Bắt đầu ngay